ProxyProviderSvc Class Reference

manages the address providers and add proxies on demand to the store More...

#include <ProxyProviderSvc.h>

Inheritance diagram for ProxyProviderSvc:

Collaboration diagram for ProxyProviderSvc:

Public Types
typedef std::list< IAddressProvider * >::iterator	pAPiterator
typedef std::list< SG::TransientAddress * >	TAdList
typedef TAdList::iterator	TAdIterator

Public Member Functions
virtual StatusCode	preLoadProxies (IProxyRegistry &storeToModify) override
	IProxyProvider interface. More...
virtual StatusCode	loadProxies (IProxyRegistry &storeToModify) override
	add proxies to the store to modify (during Begin Event) More...
virtual SG::DataProxy *	retrieveProxy (const CLID &id, const std::string &key, IProxyRegistry &storeToModify) override
	Use a provider to create a proxy for ID/KEY. More...
SG::DataProxy *	addAddress (IProxyRegistry &storeToModify, SG::TransientAddress &&tad)
	create a new Proxy, overriding CLID and/or key More...
virtual void	addProvider (IAddressProvider *aProvider) override final
	IAddressProvider manager functionality add a provider to the set of known ones. More...
virtual StatusCode	initialize () override
	Service boilerplate. More...
	ProxyProviderSvc (const std::string &name, ISvcLocator *svcLoc)
	Standard Service Constructor. More...
virtual	~ProxyProviderSvc ()

Private Member Functions
const EventContext &	contextFromStore (IProxyRegistry &ds) const
	Retrieve the EventContext saved in store DS. More...
StatusCode	addAddresses (IProxyRegistry &store, TAdList &tList)
	Add lists of TADs to the store. More...
void	providerNamesPropertyHandler (Gaudi::Details::PropertyBase &theProp)
	the handler for m_providerNames More...
StatusCode	doPreLoadProxies (IProxyRegistry &storeToModify)

Private Attributes
StringArrayProperty	m_providerNames
	property: the services declared as providers More...
std::list< IAddressProvider * >	m_providers
	the providers we know about. WE DON'T OWN THEM More...
IConversionSvc *	m_pDataLoader {nullptr}
	Persistency Service. More...
std::vector< IProxyRegistry * >	m_pendingLoad
	List of pending stores on which to run preLoadProxies(). More...

Detailed Description

manages the address providers and add proxies on demand to the store

Definition at line 42 of file ProxyProviderSvc.h.

Member Typedef Documentation

pAPiterator

typedef std::list<IAddressProvider*>::iterator ProxyProviderSvc::pAPiterator

Definition at line 45 of file ProxyProviderSvc.h.

TAdIterator

typedef TAdList::iterator ProxyProviderSvc::TAdIterator

Definition at line 47 of file ProxyProviderSvc.h.

TAdList

typedef std::list<SG::TransientAddress*> ProxyProviderSvc::TAdList

Definition at line 46 of file ProxyProviderSvc.h.

Constructor & Destructor Documentation

ProxyProviderSvc()

ProxyProviderSvc::ProxyProviderSvc	(	const std::string &	name,
		ISvcLocator *	svcLoc
	)

Standard Service Constructor.

Definition at line 51 of file ProxyProviderSvc.cxx.

                                                       : 
  base_class(name, svcLoc){
  m_providerNames.declareUpdateHandler(&ProxyProviderSvc::providerNamesPropertyHandler, this);
}

~ProxyProviderSvc()

ProxyProviderSvc::~ProxyProviderSvc ( )

virtual

Definition at line 57 of file ProxyProviderSvc.cxx.

{}

Member Function Documentation

addAddress()

SG::DataProxy * ProxyProviderSvc::addAddress	(	IProxyRegistry &	storeToModify,
		SG::TransientAddress &&	tad
	)

create a new Proxy, overriding CLID and/or key

Definition at line 192 of file ProxyProviderSvc.cxx.

{  
  //HACK! The proxies for all object those key starts with "HLTAutoKey" will be deleted at the end of each event (resetOnly=false)
  //hence avoiding the proxy explosion observed with trigger object for releases <= 14.1.0
  bool resetOnly(tAddr.name().substr(0,10) != std::string("HLTAutoKey"));
  // std::cout << "PPS:addAdress: proxy for key " << tAddr->name() << " has resetOnly " << resetOnly << std::endl;
  SG::DataProxy* dp = new SG::DataProxy(std::move(tAddr),
                                        m_pDataLoader, true, resetOnly );
 
  // Must add the primary CLID first.
  bool addedProxy = store.addToStore(dp->clID(), dp).isSuccess();
  //  ATH_MSG_VERBOSE("created proxy for " << tAddr->clID() << "/" << tAddr->name() << "using " << m_pDataLoader->repSvcType());
  if (!addedProxy) {
    ATH_MSG_ERROR ("Failed to add proxy to store "
                   << dp->clID() << "/" << dp->name());
    delete dp;
    dp = nullptr;
  }
  else {
    // loop over all the transient CLIDs:
    SG::TransientAddress::TransientClidSet tClid = dp->transientID();
    for (CLID clid : tClid) {
      if (clid != dp->clID()) {
        bool flag = (store.addToStore(clid, dp)).isSuccess();
        if (!flag) {
          ATH_MSG_ERROR ("Failed to add proxy to store for symlink "
                         << clid << "/" << dp->name());
        }
        addedProxy &= flag;
      }
    }
 
    // loop over all alias'
    for (const std::string& alias : dp->alias()) {
      (store.addAlias(alias, dp)).ignore();
    }
    
    // Add any other allowable conversions.
    const SG::BaseInfoBase* bi = getBaseInfo (dp->clID());
    if (bi) {
      for (CLID clid : bi->get_bases()) {
        if (std::find (tClid.begin(), tClid.end(), clid) == tClid.end()) {
      store.addToStore (clid, dp).ignore();
          dp->setTransientID (clid);
        }
      }
 
      for (CLID clid : bi->get_copy_conversions()) {
        if (std::find (tClid.begin(), tClid.end(), clid) == tClid.end()) {
      store.addToStore (clid, dp).ignore();
          dp->setTransientID (clid);
        }
      }
    }
  }
 
  return dp;
}

addAddresses()

StatusCode ProxyProviderSvc::addAddresses ( IProxyRegistry &  store, TAdList &  tList  )

private

Add lists of TADs to the store.

Parameters

store	Store to which to add.
tList	List of TADs from all providers.

if proxy exists, simply update the proxy with new TransientAddress, else construct a new proxy

Definition at line 166 of file ProxyProviderSvc.cxx.

{
  for (SG::TransientAddress* tad : tList) {
    SG::DataProxy* proxy = store.proxy_exact(tad->clID(), tad->name());
    if (0 != proxy) 
    {
      proxy->setAddress(tad->address());
      if (proxy->provider() == 0) {
        proxy->setProvider(tad->provider(), store.storeID());
      }
    }
    else {
      if ( 0 == addAddress(store, std::move(*tad)) ) return StatusCode::FAILURE;
    }
    delete tad;
  }
  
  return StatusCode::SUCCESS;
}

addProvider()

void ProxyProviderSvc::addProvider ( IAddressProvider *  aProvider )

inlinefinaloverridevirtual

IAddressProvider manager functionality add a provider to the set of known ones.

PROVIDER IS OWNED BY THE CLIENT

Definition at line 120 of file ProxyProviderSvc.h.

                                                                     {
  assert(aProvider);
  if (find(m_providers.begin(), m_providers.end(), aProvider) == m_providers.end()) {
    m_providers.push_back(aProvider);
  }
}

contextFromStore()

const EventContext & ProxyProviderSvc::contextFromStore ( IProxyRegistry &  ds ) const

private

Retrieve the EventContext saved in store DS.

Parameters

ds	The store from which to retrieve the context.

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

Definition at line 282 of file ProxyProviderSvc.cxx.

{
  SG::DataProxy* proxy = ds.proxy (ClassID_traits<EventContext>::ID(),
                                   "EventContext");
  if (proxy) {
    EventContext* ctx = SG::DataProxy_cast<EventContext> (proxy);
    if (ctx) return *ctx;
  }
  static const EventContext emptyContext;
  return emptyContext;
}

doPreLoadProxies()

StatusCode ProxyProviderSvc::doPreLoadProxies ( IProxyRegistry &  storeToModify )

private

Definition at line 110 of file ProxyProviderSvc.cxx.

{
  if (m_providers.empty()) return StatusCode::SUCCESS;
 
  StoreID::type storeID = store.storeID();
  TAdList tList;
  for (IAddressProvider* provider : m_providers) {
    ATH_CHECK( provider->preLoadAddresses(storeID, tList) );
    setProviderOnList (tList, provider, storeID);
  }
  ATH_CHECK( addAddresses (store, tList) );
  return StatusCode::SUCCESS;
}

initialize()

StatusCode ProxyProviderSvc::initialize ( )

overridevirtual

Service boilerplate.

Definition at line 60 of file ProxyProviderSvc.cxx.

{
  ATH_MSG_VERBOSE( "Initializing " << name() );
 
  const bool CREATEIF(true);
  // cache pointer to Persistency Service
  if (!(service("EventPersistencySvc", m_pDataLoader, CREATEIF)).isSuccess()) {
    m_pDataLoader = 0;
    ATH_MSG_ERROR("Could not     get pointer to Persistency Service");
    return StatusCode::FAILURE;
  } else {
#ifdef DEBUGPPS
    ATH_MSG_VERBOSE("Got pointer to Persistency Service " << m_pDataLoader);
#endif
  }
 
  //get properties set; 
  if(!(AthService::initialize()).isSuccess()) {
    return StatusCode::FAILURE;
  }
 
  // Take care of any pending preLoadProxies requests.
  for (IProxyRegistry* reg : m_pendingLoad) {
    CHECK( doPreLoadProxies (*reg) );
  }
  m_pendingLoad.clear();
 
  return StatusCode::SUCCESS;
}

loadProxies()

StatusCode ProxyProviderSvc::loadProxies ( IProxyRegistry &  storeToModify )

overridevirtual

add proxies to the store to modify (during Begin Event)

IProxyProvider interface add proxies to the store to modify.

Definition at line 146 of file ProxyProviderSvc.cxx.

{
  if (m_providers.empty()) return StatusCode::SUCCESS;
 
  StoreID::type storeID = store.storeID();
  TAdList tList;
  for (IAddressProvider* provider : m_providers) {
    ATH_CHECK( provider->loadAddresses(storeID, tList) );
    setProviderOnList (tList, provider, storeID);
  }
  ATH_CHECK( addAddresses (store, tList) );
  return StatusCode::SUCCESS;
}

preLoadProxies()

StatusCode ProxyProviderSvc::preLoadProxies ( IProxyRegistry &  storeToModify )

overridevirtual

IProxyProvider interface.

IProxyProvider interface add proxies (before Begin Event)

add proxies to the store to modify (before Begin Event)

Definition at line 128 of file ProxyProviderSvc.cxx.

{
  // Due to initialization loops, it's possible for this to be called
  // before the service is fully initialized.  In that case, we may
  // skip calling some of the providers.  So we haven't been fully initialized,
  // don't do anything now; rather, remember the store, and call
  // preLoadProxies again for it at the end of initialize().
  if (FSMState() == Gaudi::StateMachine::OFFLINE) {
    m_pendingLoad.push_back (&store);
    return StatusCode::SUCCESS;
  }
  return doPreLoadProxies (store);
}

providerNamesPropertyHandler()

void ProxyProviderSvc::providerNamesPropertyHandler ( Gaudi::Details::PropertyBase &  theProp )

private

the handler for m_providerNames

Definition at line 296 of file ProxyProviderSvc.cxx.

                                                                            {
  //add declared providers to the list;
  std::vector<std::string> providerNames = m_providerNames.value();
 
  // FIXME: AddressRemappingSvc needs to come at the end, if it's provided.
  auto it = std::find (providerNames.begin(), providerNames.end(),
                       "AddressRemappingSvc");
  if (it != providerNames.end() &&  it != providerNames.end()-1) {
    providerNames.erase (it);
    providerNames.push_back ("AddressRemappingSvc");
  }
 
  for (const std::string& pName : providerNames) {
    IService *pIS(0);
    IAddressProvider *pAP(0);
    ListItem tn(pName);
    if (!(service(tn.type(), tn.name(), pIS)).isSuccess() ||
    0 == (pAP = dynamic_cast<IAddressProvider*>(pIS))) {
      ATH_MSG_ERROR(" getting Address Provider "<< pName);
      throw GaudiException("Failed to locate address provider",
               "ProxyProviderSvc::providerNamesPropertyHandle", 
               StatusCode::FAILURE);
 
    } else {
      ATH_MSG_DEBUG(" added Address Provider "<< pIS->name());
    }
    ProxyProviderSvc::addProvider(pAP);
  }
 
}

retrieveProxy()

SG::DataProxy * ProxyProviderSvc::retrieveProxy ( const CLID &  id, const std::string &  key, IProxyRegistry &  store  )

overridevirtual

Use a provider to create a proxy for ID/KEY.

If successful, the new proxy will be added to DATASTORE and returned; otherwise, return null.

Definition at line 256 of file ProxyProviderSvc.cxx.

{
  if ( !m_providers.empty() ) {
    const EventContext& ctx = contextFromStore (store);
    SG::TransientAddress pTAd (id, key);
    pAPiterator iProvider(m_providers.begin()), iEnd(m_providers.end());
    for (; iProvider != iEnd; ++iProvider) {
      if ( ((*iProvider)->updateAddress(store.storeID(),&pTAd,ctx)).isSuccess() ) 
    {
      pTAd.setProvider(*iProvider, store.storeID());
      return this->addAddress(store,std::move(pTAd));
    }
    }  
  }  
  
  return nullptr;
}

Member Data Documentation

m_pDataLoader

IConversionSvc* ProxyProviderSvc::m_pDataLoader {nullptr}

private

Persistency Service.

Definition at line 113 of file ProxyProviderSvc.h.

m_pendingLoad

std::vector<IProxyRegistry*> ProxyProviderSvc::m_pendingLoad

private

List of pending stores on which to run preLoadProxies().

Definition at line 116 of file ProxyProviderSvc.h.

m_providerNames

StringArrayProperty ProxyProviderSvc::m_providerNames

private

Initial value:

{this,"ProviderNames",{},
      "names of the services to be use as address providers","OrderedSet<std::string>"}

property: the services declared as providers

Definition at line 103 of file ProxyProviderSvc.h.

m_providers

std::list<IAddressProvider*> ProxyProviderSvc::m_providers

private

the providers we know about. WE DON'T OWN THEM

Definition at line 111 of file ProxyProviderSvc.h.

---

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

• ProxyProviderSvc.h
• ProxyProviderSvc.cxx