xAODMaker::ElementLinkResetAlg Class Reference

Algorithm reseting ElementLink objects to their default state. More...

#include <ElementLinkResetAlg.h>

Inheritance diagram for xAODMaker::ElementLinkResetAlg:

Collaboration diagram for xAODMaker::ElementLinkResetAlg:

Classes
class	AuxIDType
	Helper class for caching auxiliary ID types. More...

Public Member Functions
	ElementLinkResetAlg (const std::string &name, ISvcLocator *svcLoc)
	Regular Algorithm constructor.
virtual StatusCode	initialize ()
	Function initialising the algorithm.
virtual StatusCode	execute ()
	Function executing the algorithm.
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	reset (const SG::IConstAuxStore &store, const std::string &key)
	Function reseting all the ElementLinks in one specific container.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
std::vector< std::string >	m_keys
	StoreGate keys of the auxiliary objects to be processed.
std::vector< AuxIDType >	m_typeCache
	Cached types of the auxiliary IDs.
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Algorithm reseting ElementLink objects to their default state.

   This algorithm can be used to make sure that during/after an
   AODFix-like configuration EDM objects are not left with cached
   pointers to no longer existing objects.

   The algorithm can make sure that every ElementLink in some
   selected container(s), or all containers that are in StoreGate,
   are cleared of all cached information.

Author

Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Definition at line 39 of file ElementLinkResetAlg.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

ElementLinkResetAlg()

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

Regular Algorithm constructor.

Definition at line 23 of file ElementLinkResetAlg.cxx.

      : AthAlgorithm( name, svcLoc ) {
 
      declareProperty( "SGKeys", m_keys );
   }

Member Function Documentation

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode xAODMaker::ElementLinkResetAlg::execute ( )

virtual

Function executing the algorithm.

Definition at line 40 of file ElementLinkResetAlg.cxx.

                                           {
 
      // Collect all the container(s):
      std::vector< std::pair< const SG::IConstAuxStore*, std::string > > stores;
      if( !m_keys.empty() ) {
         for( const std::string& key : m_keys ) {
            const SG::IConstAuxStore* store = nullptr;
            ATH_CHECK( evtStore()->retrieve( store, key ) );
            stores.emplace_back( store, key );
         }
      } else {
         SG::ConstIterator< SG::IConstAuxStore > itr, end;
         ATH_CHECK( evtStore()->retrieve( itr, end ) );
         for( ; itr != end; ++itr ) {
            const SG::IConstAuxStore* store = nullptr;
            ATH_CHECK( evtStore()->retrieve( store, itr.key() ) );
            stores.emplace_back( store, itr.key() );
         }
      }
      ATH_MSG_DEBUG( "Number of IConstAuxStore objects retrieved: "
                     << stores.size() );
 
      // Reset the ElementLinks in all of them:
      for( const auto& storeKey : stores ) {
         ATH_MSG_VERBOSE( "Reseting element links in store: "
                          << storeKey.second );
         ATH_CHECK( reset( *( storeKey.first ), storeKey.second ) );
      }
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

initialize()

StatusCode xAODMaker::ElementLinkResetAlg::initialize ( )

virtual

Function initialising the algorithm.

Definition at line 30 of file ElementLinkResetAlg.cxx.

                                              {
 
      // Tell the user what's happening:
      ATH_MSG_INFO( "Initialising" );
      ATH_MSG_DEBUG( "SGKeys = " << m_keys );
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

msg()

MsgStream & AthCommonMsg< Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

reset()

StatusCode xAODMaker::ElementLinkResetAlg::reset ( const SG::IConstAuxStore & store, const std::string & key )

private

Function reseting all the ElementLinks in one specific container.

Definition at line 73 of file ElementLinkResetAlg.cxx.

                                                                 {
 
      // If the container is empty, return right away:
      if( ! store.size() ) {
         return StatusCode::SUCCESS;
      }
 
      // Get all the IDs stored in this object:
      const SG::auxid_set_t& auxids = store.getAuxIDs();
 
      // The auxiliary type registry:
      SG::AuxTypeRegistry& reg = SG::AuxTypeRegistry::instance();
 
      // Loop over them:
      for( SG::auxid_t auxid : auxids ) {
 
         // Check/cache its type:
         if( m_typeCache.size() <= auxid ) {
            m_typeCache.resize( auxid + 1 );
         }
         if( ! m_typeCache[ auxid ].isSet ) {
            const std::string tname =
               SG::normalizedTypeinfoName( *( reg.getType( auxid ) ) );
            static const std::string pat1 = "ElementLink<";
            static const std::string pat2 = "std::vector<ElementLink<";
            if( tname.substr( 0, pat1.size() ) == pat1 ) {
               m_typeCache[ auxid ].isEL = true;
            } else if( tname.substr( 0, pat2.size() ) == pat2 ) {
               m_typeCache[ auxid ].isELVec = true;
            }
            m_typeCache[ auxid ].isSet = true;
            ATH_MSG_VERBOSE( "Type for \"" << tname << "\": isEL = "
                             << m_typeCache[ auxid ].isEL << ", isELVec = "
                             << m_typeCache[ auxid ].isELVec );
         }
 
         // If it's not an EL type, then don't bother:
         if( ! ( m_typeCache[ auxid ].isEL || m_typeCache[ auxid ].isELVec ) ) {
            continue;
         }
 
         // Get a pointer to the vector variable. We need to cast away
         // its constness in this ugly way, we can't afford to only ask for
         // non-const pointers from the store. Since the ElementLink to be
         // reset may very well be a const variable that was accessed already,
         // and now needs its cache wiped.
         void* ptr = const_cast< void* >( store.getData( auxid ) );
 
         // If the pointer is null, then something dodgy happened with this
         // (dynamic) variable.
         if( ! ptr ) {
            // Check if this is a static variable. If it is, it's not an error
            // to get a null pointer for it. Since such a case can only happen
            // when a new static variable was introduced into the EDM, and we're
            // reading an old input file that doesn't have this variable in it
            // yet. Which is an okay scenario.
            const SG::IAuxStoreIO* storeIO =
               dynamic_cast< const SG::IAuxStoreIO* >( &store );
            if( ( ! storeIO ) || ( storeIO->getDynamicAuxIDs().find( auxid ) !=
                                   storeIO->getDynamicAuxIDs().end() ) ) {
               REPORT_MESSAGE( MSG::ERROR )
                  << "Invalid pointer received for variable: " << key
                  << reg.getName( auxid );
            } else {
               ATH_MSG_DEBUG( "Static variable " << key << reg.getName( auxid )
                              << " is empty" );
            }
            continue;
         }
 
         // Get the variable's element size:
         const size_t eltSize = reg.getEltSize( auxid );
 
         // Loop over its elements:
         const size_t sz_i = store.size();
         for( size_t i = 0; i < sz_i; ++i ) {
 
            // Raw pointer to the object:
            void* eltPtr = reinterpret_cast< char* >( ptr ) + i * eltSize;
 
            // Do different things based on the variable type:
            if( m_typeCache[ auxid ].isEL ) {
               // Cast to an ElementLinkBase object:
               ElementLinkBase* elb =
                  reinterpret_cast< ElementLinkBase* >( eltPtr );
               // Reset the link only if it has its persistent variable(s) set:
               if( elb->persKey() ) {
                  elb->toTransient();
               }
            } else if( m_typeCache[ auxid ].isELVec ) {
               // For a vector of links we heavily rely on knowing how GCC/Clang
               // lays out the memory for vectors.
               std::vector< ElementLinkBase >& v =
                  *( reinterpret_cast< std::vector< ElementLinkBase >* >( eltPtr ) );
               const size_t sz_j = v.size();
               for( size_t j = 0; j < sz_j; ++j ) {
                  // Access the link:
                  ElementLinkBase& elb = v[ j ];
                  // Reset the link only if it has its persistent variable(s)
                  // set:
                  if( elb.persKey() ) {
                     elb.toTransient();
                  }
               }
            } else {
               ATH_MSG_FATAL( "There is a logic error in the code" );
               return StatusCode::FAILURE;
            }
         }
      }
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

m_keys

std::vector< std::string > xAODMaker::ElementLinkResetAlg::m_keys

private

StoreGate keys of the auxiliary objects to be processed.

Definition at line 56 of file ElementLinkResetAlg.h.

m_typeCache

std::vector< AuxIDType > xAODMaker::ElementLinkResetAlg::m_typeCache

private

Cached types of the auxiliary IDs.

Definition at line 68 of file ElementLinkResetAlg.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• ElementLinkResetAlg.h
• ElementLinkResetAlg.cxx