Algorithm for fixing dynamic variable corruption on xAOD containers. More...

#include <DynVarFixerAlg.h>

Inheritance diagram for xAODMaker::DynVarFixerAlg:

Collaboration diagram for xAODMaker::DynVarFixerAlg:

Public Member Functions
StatusCode	initialize () override
	Function initialising the algorithm.
StatusCode	execute () override
	Function executing the algorithm.
	AthAlgorithm (const std::string &name, ISvcLocator *pSvcLocator)
	Inherit the base class's constructor.
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
::TClass *	getClass (SG::auxid_t auxid)
	Get the dictionary describing an auxiliary vector variable.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadHandleKeyArray< SG::IAuxStoreIO >	m_ioKeys
	Containers to access with the `SG::IAuxStoreIO` interface.
std::vector< ::TClass * >	m_dicts
	Cache of the dictionaries used.
std::vector< bool >	m_noDict
	Flag showing which variables don't have a dictionary for them.
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
Algorithm properties
SG::ReadHandleKeyArray< SG::IConstAuxStore >	m_constKeys
	Containers to access with the `SG::IConstAuxStore` interface.

Detailed Description

Algorithm for fixing dynamic variable corruption on xAOD containers.

This is a general algorithm for fixing problems where a dynamic auxiliary variable of a container is not the right size. Which can happen when the algorithm creating the container doesn't consistently create dynamic variables for all objects. (Not creating some variables if some selection fails for instance.)

This is a generalisation of algorithms like xAODMaker::TrackLinkFixerAlg and xAODMaker::BTaggingAuxFixerAlg.

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 41 of file DynVarFixerAlg.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

◆ AthAlgorithm()

AthAlgorithm::AthAlgorithm	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Inherit the base class's constructor.

Definition at line 51 of file AthAlgorithm.cxx.

                                                       :
  ::AthCommonDataStore<AthCommonMsg<Algorithm>>   ( name, pSvcLocator )
{
  // Set up to run AthAlgorithmDHUpdate in sysInitialize before
  // merging dependency lists.  This extends the output dependency
  // list with any symlinks implied by inheritance relations.
  m_updateDataHandles =
    std::make_unique<AthenaBaseComps::AthAlgorithmDHUpdate>
    (m_extendedExtraObjects,
     std::move (m_updateDataHandles));
}

◆ 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.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ 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.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode xAODMaker::DynVarFixerAlg::execute ( )

override

Function executing the algorithm.

Definition at line 47 of file DynVarFixerAlg.cxx.

                                      {
 
      // Construct the SG::IConstAuxStore and SG::IAuxStoreIO read handles.
      auto constHandles = m_constKeys.makeHandles();
      auto ioHandles = m_ioKeys.makeHandles();
      assert( constHandles.size() == ioHandles.size() );
 
      // Loop over the specified containers:
      for( std::size_t i = 0; i < constHandles.size(); ++i ) {
 
         // Access the appropriate handles.
         SG::ReadHandle< SG::IConstAuxStore >& constHandle =
            constHandles.at( i );
         SG::ReadHandle< SG::IAuxStoreIO >& ioHandle =
            ioHandles.at( i );
 
         // If the store is empty, stop here.
         if( constHandle->size() == 0 ) {
            continue;
         }
 
         // Remember the store's name and size.
         const std::string& cname = constHandle.key();
         const size_t size = constHandle->size();
         ATH_MSG_VERBOSE( "Size of container \"" << cname << "\": " << size );
 
         // Loop over all dynamic variables of the container:
         for( SG::auxid_t auxid : ioHandle->getDynamicAuxIDs() ) {
 
            // Access the registry:
            static const auto& reg = SG::AuxTypeRegistry::instance();
 
            // Tell the user what's happening.
            ATH_MSG_VERBOSE( "Checking variable \"" << cname
                             << reg.getName( auxid ) << "\"" );
 
            // Access the std::vector variable:
            const void* vecPtr = ioHandle->getIOData( auxid );
 
            // Get a dictionary for the variable:
            ::TClass* cl = getClass( auxid );
            if( ! cl ) {
               continue;
            }
 
            // Get the collection proxy for the class:
            ::TVirtualCollectionProxy* proxy = cl->GetCollectionProxy();
            if( ! proxy ) {
               ATH_MSG_FATAL( "Couldn't get collection proxy for variable \""
                              << reg.getName( auxid ) << "\"" );
               return StatusCode::FAILURE;
            }
 
            // Attach the proxy to the auxiliary variable:
            ::TVirtualCollectionProxy::TPushPop helper( proxy,
                                                        ( void* ) vecPtr );
 
            // Check if the variable is of the right size. If it is, don't
            // bother the variable any longer.
            if( proxy->Size() == size ) {
               continue;
            }
            ATH_MSG_VERBOSE( "Size of variable \"" << cname
                             << reg.getName( auxid ) << "\": "
                             << proxy->Size() );
 
            // If it's not, then try to resize it using the TGenCollectionProxy
            // interface:
            ::TGenCollectionProxy* genProxy =
                  dynamic_cast< ::TGenCollectionProxy* >( proxy );
            if( ! genProxy ) {
               ATH_MSG_WARNING( "Variable \"" << reg.getName( auxid )
                                << "\" doesn't have a TGenCollectionProxy. "
                                << "Variable not fixed!" );
               continue;
            }
 
            // Resize the variable to the right size:
            static const ::Bool_t FORCE_DELETE = kFALSE;
            genProxy->Resize( size, FORCE_DELETE );
            ATH_MSG_VERBOSE( "Size of variable \"" << cname
                             << reg.getName( auxid ) << "\" after resize: "
                             << proxy->Size() );
            ATH_MSG_DEBUG( "Fixed variable: \"" << cname << reg.getName( auxid )
                           << "\"" );
         }
      }
 
      // 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();
}

◆ getClass()

TClass * xAODMaker::DynVarFixerAlg::getClass ( SG::auxid_t auxid )

private

Get the dictionary describing an auxiliary vector variable.

Definition at line 139 of file DynVarFixerAlg.cxx.

                                                     {
 
      // Check if we already checked, and there's no dictionary available for
      // this type:
      if( ( m_noDict.size() > auxid ) && m_noDict[ auxid ] ) {
         return nullptr;
      }
 
      // Check if the cache already has this variable:
      if( ( m_dicts.size() > auxid ) && m_dicts[ auxid ] ) {
         return m_dicts[ auxid ];
      }
 
      // Make sure that the cache variables are large enough:
      if( m_dicts.size() <= auxid ) {
         m_dicts.resize( auxid + 1, nullptr );
      }
      if( m_noDict.size() <= auxid ) {
         m_noDict.resize( auxid + 1, false );
      }
 
      // If not, then look for a dictionary for this type:
      static const auto& reg = SG::AuxTypeRegistry::instance();
      static const ::Bool_t LOAD = kTRUE;
      static const ::Bool_t SILENT = kTRUE;
      ::TClass* cl = ::TClass::GetClass( reg.getVecTypeName( auxid ).c_str(),
                                         LOAD, SILENT );
 
      // Cache the result:
      if( cl ) {
         m_dicts[ auxid ] = cl;
      } else {
         ATH_MSG_INFO( "No dictionary available for variable \""
                       << reg.getName( auxid ) << "\"" );
         m_noDict[ auxid ] = true;
      }
 
      // Return what we found:
      return cl;
   }

◆ initialize()

StatusCode xAODMaker::DynVarFixerAlg::initialize ( )

override

Function initialising the algorithm.

Definition at line 24 of file DynVarFixerAlg.cxx.

                                         {
 
      // Greet the user.
      ATH_MSG_INFO( "Initialising" );
      ATH_MSG_DEBUG( "Will be fixing dynamic variables in container(s):" );
      ATH_MSG_DEBUG( "  " << m_constKeys );
 
      // Initialise the read handle keys.
      ATH_CHECK( m_constKeys.initialize() );
      std::vector< std::string > keys( m_constKeys.size() );
      std::transform( m_constKeys.begin(), m_constKeys.end(), keys.begin(),
                      []( const SG::ReadHandleKey< SG::IConstAuxStore >& key ) {
                         return key.key(); } );
      ATH_CHECK( m_ioKeys.assign( keys ) );
      ATH_CHECK( m_ioKeys.initialize() );
 
      // Reset the cache variable.
      m_dicts.clear();
 
      // 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();
  }

◆ 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_constKeys

SG::ReadHandleKeyArray< SG::IConstAuxStore > xAODMaker::DynVarFixerAlg::m_constKeys

private

Initial value:

{

this, "Containers", {}, "Containers to fix up the dynamic variables of" }

Containers to access with the SG::IConstAuxStore interface.

Definition at line 60 of file DynVarFixerAlg.h.

60 {

61 this, "Containers", {}, "Containers to fix up the dynamic variables of" };

◆ 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_dicts

std::vector< ::TClass* > xAODMaker::DynVarFixerAlg::m_dicts

private

Cache of the dictionaries used.

Definition at line 74 of file DynVarFixerAlg.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_ioKeys

SG::ReadHandleKeyArray< SG::IAuxStoreIO > xAODMaker::DynVarFixerAlg::m_ioKeys

private

Containers to access with the SG::IAuxStoreIO interface.

Note that this variable is not set up as a property on the algorithm. It is instead filled by the algorithm in its initialize() function. (Based on the content of m_constKeys )

Definition at line 71 of file DynVarFixerAlg.h.

◆ m_noDict

std::vector< bool > xAODMaker::DynVarFixerAlg::m_noDict

private

Flag showing which variables don't have a dictionary for them.

Definition at line 76 of file DynVarFixerAlg.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:

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Function Documentation

◆ AthAlgorithm()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ getClass()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_constKeys

◆ m_detStore

◆ m_dicts

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_ioKeys

◆ m_noDict

◆ m_varHandleArraysDeclared

◆ m_vhka