#include <EFTrackingXrtAlgorithm.h>

Inheritance diagram for EFTrackingXrtAlgorithm:

Collaboration diagram for EFTrackingXrtAlgorithm:

Public Member Functions
	EFTrackingXrtAlgorithm (const std::string &name, ISvcLocator *pSvcLocator)

StatusCode	initialize () override final

StatusCode	execute (const EventContext &ctx) const override final

virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...

virtual bool	isClonable () const override
	Specify if the algorithm is clonable. More...

virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant. More...

virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm. More...

virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...

virtual bool	filterPassed (const EventContext &ctx) const

virtual void	setFilterPassed (bool state, const EventContext &ctx) const

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

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

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
std::vector< SG::ReadHandleKey< std::vector< unsigned long > > >	m_inputDataStreamKeys {}
	Keys to access encoded 64bit words following the EFTracking specification. More...

std::vector< SG::WriteHandleKey< std::vector< unsigned long > > >	m_outputDataStreamKeys {}

ServiceHandle< AthXRT::IDeviceMgmtSvc >	m_DeviceMgmtSvc

Gaudi::Property< std::string >	m_xclbinPath

Gaudi::Property< std::string >	m_kernelDefinitionsJsonString

Gaudi::Property< std::size_t >	m_bufferSize

std::shared_ptr< xrt::device >	m_device {}

std::vector< std::unique_ptr< xrt::kernel > >	m_kernels {}

std::vector< std::unique_ptr< xrt::run > >	m_runs {}

std::vector< xrt::bo > m_inputBuffers	ATLAS_THREAD_SAFE {}

std::vector< xrt::bo > m_outputBuffers	ATLAS_THREAD_SAFE {}

std::vector< EFTrackingFPGAIntegration::VSize >	m_vsizes {}

DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks. More...

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

Generic Athena algorithm for running xclbins (FPGA firmware). The idea is to associate a set store gate handles with memory mapped kernel interfaces (kernels and interfaces defined in the xclbin).

The objects behind these store gate handles are then written directly to the FPGAs global memory. The kernels are then run. Finally outputs from the FPGAs global memory are written back into storegate.

Definition at line 47 of file EFTrackingXrtAlgorithm.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ EFTrackingXrtAlgorithm()

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

Definition at line 65 of file EFTrackingXrtAlgorithm.cxx.

68 : AthReentrantAlgorithm(name, pSvcLocator)

69 {}

Member Function Documentation

◆ cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::cardinality

overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Definition at line 75 of file AthCommonReentrantAlgorithm.cxx.

 {
   return 0;
 }

◆ declareGaudiProperty() [1/4]

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

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	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());
  
   }

◆ declareGaudiProperty() [3/4]

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

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T > & 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< Gaudi::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; }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::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; }

◆ evtStore() [2/2]

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

inlineinherited

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

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ execute()

StatusCode EFTrackingXrtAlgorithm::execute ( const EventContext & ctx ) const

finaloverride

Definition at line 179 of file EFTrackingXrtAlgorithm.cxx.

 {
   ATH_MSG_DEBUG("Writing Inputs");
   std::size_t handleIndex = 0;
   for (
     const SG::ReadHandleKey<std::vector<unsigned long>>& inputDataStreamKey : 
     m_inputDataStreamKeys
   ) {
     SG::ReadHandle<std::vector<unsigned long>> inputDataStream(inputDataStreamKey, ctx);
     unsigned long* inputMap = m_inputBuffers.at(handleIndex).map<unsigned long*>();
  
     if (inputDataStream->size() > m_bufferSize) {
       ATH_MSG_ERROR("Input data stream too large for buffer (buffer: " << 
                     m_bufferSize << 
                     ", data stream: " << 
                     inputDataStream->size() << 
                     "), consider increasing buffer size.");
  
       return StatusCode::FAILURE;
     }
  
     for (std::size_t index = 0; index < inputDataStream->size(); index++) {
       inputMap[index] = inputDataStream->at(index);
     }
     
     m_inputBuffers.at(handleIndex).sync(XCL_BO_SYNC_BO_TO_DEVICE);
     handleIndex++;
   }
  
   ATH_MSG_DEBUG("Writing VSizes");
   for (const EFTrackingFPGAIntegration::VSize& vsize : m_vsizes) {
     SG::ReadHandle<std::vector<unsigned long>> inputDataStream(vsize.storeGateKey, ctx);
  
     m_runs.at(vsize.runIndex)->set_arg(vsize.argumentIndex, inputDataStream->size());
   }
  
   ATH_MSG_DEBUG("Starting Kernels");
   for (std::size_t index = 0; index < m_runs.size(); index++) {
     m_runs.at(index)->start();
   }
  
   ATH_MSG_DEBUG("Waiting for Kernels");
   for (std::size_t index = 0; index < m_runs.size(); index++) {
     m_runs.at(index)->wait();
   }
  
   ATH_MSG_DEBUG("Reading Outputs");
   handleIndex = 0;
   for (
     const SG::WriteHandleKey<std::vector<unsigned long>>& outputDataStreamKey : 
     m_outputDataStreamKeys
   ) {
     SG::WriteHandle<std::vector<unsigned long>> outputDataStream(outputDataStreamKey, ctx);
     ATH_CHECK(outputDataStream.record(std::make_unique<std::vector<unsigned long>>(m_bufferSize)));
  
     m_outputBuffers.at(handleIndex).sync(XCL_BO_SYNC_BO_FROM_DEVICE);
  
     const unsigned long* outputMap = m_outputBuffers.at(handleIndex).map<unsigned long*>();
  
     for (std::size_t index = 0; index < outputDataStream->size(); index++) {
       outputDataStream->at(index) = outputMap[index];
     }
     
     handleIndex++;
   }
  
   return StatusCode::SUCCESS;
 }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::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 & AthCommonReentrantAlgorithm< Gaudi::Algorithm >::extraOutputDeps

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 94 of file AthCommonReentrantAlgorithm.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 BaseAlg::extraOutputDeps();
 }

◆ filterPassed()

virtual bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

                                                            {
     return execState( ctx ).filterPassed();
   }

◆ initialize()

StatusCode EFTrackingXrtAlgorithm::initialize ( )

finaloverride

Definition at line 71 of file EFTrackingXrtAlgorithm.cxx.

                                               {
   ATH_MSG_INFO("Initializing " << name());
  
   // Too complicated to implement as a Gaudi::Property (would require a new 
   // grammar) so get a string and make the nlohmann::json in initialize. 
   const std::optional<nlohmann::json> kernelDefinitionsJson {
     [](const std::string& kernelDefinitionsJsonString)->std::optional<nlohmann::json> {
       try {
         const nlohmann::json kernelDefinitionsJson = 
           nlohmann::json::parse(kernelDefinitionsJsonString);
         return kernelDefinitionsJson;
  
       }
       catch (const nlohmann::json::exception& [[maybe_unused]]exception) {
         return std::nullopt;
       }
  
       // c++23 std::unreachable()
       return std::nullopt;
     }(m_kernelDefinitionsJsonString)
   };
  
   if (!kernelDefinitionsJson) {
     return StatusCode::FAILURE; 
   }
  
   ATH_CHECK(m_DeviceMgmtSvc.retrieve());
  
   // Todo: Fix this disgusting mess (probably just add a new method to the 
   //       AthXrt service to enumerate devices and a method to check if a 
   //       device has a particular kernel.
   m_device = getDevice(*kernelDefinitionsJson, m_DeviceMgmtSvc);
   if (!m_device) {
     ATH_MSG_ERROR("No XRT device provides all kernels.");
  
     return StatusCode::FAILURE;
   }
  
   for (const auto& [kernelName, kernelDefinition] : kernelDefinitionsJson->items()) {
     m_kernels.push_back(std::make_unique<xrt::kernel>(*m_device, 
                                                       m_device->get_xclbin_uuid(), 
                                                       kernelName,
                                                       xrt::kernel::cu_access_mode::exclusive));
  
     m_runs.push_back(std::make_unique<xrt::run>(*m_kernels.back()));
  
     for (const auto& interfaceDefinition : kernelDefinition) {
       const std::string& storeGateKey = 
         interfaceDefinition.at("storeGateKey").get<const std::string>();
  
       const int argumentIndex = 
         std::stoi(interfaceDefinition.at("argumentIndex").get<const std::string>());
  
       const int interfaceMode = 
         std::stoi(interfaceDefinition.at("interfaceMode").get<const std::string>());
  
       switch (interfaceMode) {
         case EFTrackingXrtParameters::InterfaceMode::INPUT: {
           m_inputDataStreamKeys.emplace_back(storeGateKey);
           ATH_CHECK(m_inputDataStreamKeys.back().initialize());
  
           m_inputBuffers.emplace_back(
             *m_device, 
             sizeof(unsigned long) * m_bufferSize, 
             xrt::bo::flags::normal, 
             m_kernels.back()->group_id(argumentIndex)
           );
  
           m_runs.back()->set_arg(argumentIndex, m_inputBuffers.back());
  
           break;
         }
         case EFTrackingXrtParameters::InterfaceMode::OUTPUT: {
           m_outputDataStreamKeys.emplace_back(storeGateKey);
           ATH_CHECK(m_outputDataStreamKeys.back().initialize());
  
           m_outputBuffers.emplace_back(
             *m_device, 
             sizeof(unsigned long) * m_bufferSize, 
             xrt::bo::flags::normal, 
             m_kernels.back()->group_id(argumentIndex)
           );
  
           m_runs.back()->set_arg(argumentIndex, m_outputBuffers.back());
  
           break;
         }
         case EFTrackingXrtParameters::InterfaceMode::VSIZE: {
           m_vsizes.push_back({.runIndex = static_cast<int>(m_runs.size()) - 1,
                               .argumentIndex = argumentIndex,
                               .storeGateKey = SG::ReadHandleKey<std::vector<long unsigned int>>(storeGateKey)});
  
           ATH_CHECK(m_vsizes.back().storeGateKey.initialize());
  
           break;
         }
         default: {
           ATH_MSG_ERROR("Failed to map kernel definitions to xrt objects.");     
  
           return StatusCode::FAILURE;
         }
       }
     }
   }
  
   return StatusCode::SUCCESS;
 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Gaudi::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.

◆ isClonable()

bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::isClonable

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Definition at line 68 of file AthCommonReentrantAlgorithm.cxx.

 {
   // Reentrant algorithms are clonable.
   return true;
 }

◆ msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< Gaudi::Algorithm >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< Gaudi::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< Gaudi::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< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ setFilterPassed()

virtual void AthCommonReentrantAlgorithm< Gaudi::Algorithm >::setFilterPassed	(	bool	state,
		const EventContext &	ctx
	)		const

inlinevirtualinherited

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

                                                                             {
     execState( ctx ).setFilterPassed( state );
   }

◆ sysExecute()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Definition at line 85 of file AthCommonReentrantAlgorithm.cxx.

 {
   return BaseAlg::sysExecute (ctx);
 }

◆ sysInitialize()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::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< Gaudi::Algorithm > >.

Reimplemented in InputMakerBase, and HypoBase.

Definition at line 61 of file AthCommonReentrantAlgorithm.cxx.

                                                                {
   StatusCode sc=AthCommonDataStore<AthCommonMsg<BaseAlg>>::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< Gaudi::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< Gaudi::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

◆ ATLAS_THREAD_SAFE [1/2]

std::vector<xrt::bo> m_inputBuffers EFTrackingXrtAlgorithm::ATLAS_THREAD_SAFE {}

mutableprivate

Definition at line 93 of file EFTrackingXrtAlgorithm.h.

◆ ATLAS_THREAD_SAFE [2/2]

std::vector<xrt::bo> m_outputBuffers EFTrackingXrtAlgorithm::ATLAS_THREAD_SAFE {}

mutableprivate

Definition at line 94 of file EFTrackingXrtAlgorithm.h.

◆ m_bufferSize

Gaudi::Property<std::size_t> EFTrackingXrtAlgorithm::m_bufferSize

private

Initial value:

{
    this,
    "bufferSize",
    8192,
    "Capacity of xrt buffers in terms of 64bit words."
  }

Definition at line 76 of file EFTrackingXrtAlgorithm.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_device

std::shared_ptr<xrt::device> EFTrackingXrtAlgorithm::m_device {}

private

Definition at line 84 of file EFTrackingXrtAlgorithm.h.

◆ m_DeviceMgmtSvc

ServiceHandle<AthXRT::IDeviceMgmtSvc> EFTrackingXrtAlgorithm::m_DeviceMgmtSvc

private

Initial value:

{
    this, 
    "DeviceMgmtSvc", 
    "AthXRT::DeviceMgmtSvc",
    "The XRT device manager service to use"
  }

Definition at line 55 of file EFTrackingXrtAlgorithm.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthCommonReentrantAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 114 of file AthCommonReentrantAlgorithm.h.

◆ m_inputDataStreamKeys

std::vector<SG::ReadHandleKey<std::vector<unsigned long> > > EFTrackingXrtAlgorithm::m_inputDataStreamKeys {}

private

Keys to access encoded 64bit words following the EFTracking specification.

Definition at line 52 of file EFTrackingXrtAlgorithm.h.

◆ m_kernelDefinitionsJsonString

Gaudi::Property<std::string> EFTrackingXrtAlgorithm::m_kernelDefinitionsJsonString

private

Initial value:

{
    this,
    "kernelDefinitionsJsonString",
    "{}",
    "String representation of the json kernel definitions."
  }

Definition at line 69 of file EFTrackingXrtAlgorithm.h.

◆ m_kernels

std::vector<std::unique_ptr<xrt::kernel> > EFTrackingXrtAlgorithm::m_kernels {}

private

Definition at line 87 of file EFTrackingXrtAlgorithm.h.

◆ m_outputDataStreamKeys

std::vector<SG::WriteHandleKey<std::vector<unsigned long> > > EFTrackingXrtAlgorithm::m_outputDataStreamKeys {}

private

Definition at line 53 of file EFTrackingXrtAlgorithm.h.

◆ m_runs

std::vector<std::unique_ptr<xrt::run> > EFTrackingXrtAlgorithm::m_runs {}

private

Definition at line 90 of file EFTrackingXrtAlgorithm.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

◆ m_vsizes

std::vector<EFTrackingFPGAIntegration::VSize> EFTrackingXrtAlgorithm::m_vsizes {}

private

Definition at line 97 of file EFTrackingXrtAlgorithm.h.

◆ m_xclbinPath

Gaudi::Property<std::string> EFTrackingXrtAlgorithm::m_xclbinPath

private

Initial value:

{
    this,
    "xclbinPath", 
    "", 
    "Path to Xilinx Compute Language Binary (firmware)."
  }

Definition at line 62 of file EFTrackingXrtAlgorithm.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

Constructor & Destructor Documentation

◆ EFTrackingXrtAlgorithm()

Member Function Documentation

◆ cardinality()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ filterPassed()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ ATLAS_THREAD_SAFE [1/2]

◆ ATLAS_THREAD_SAFE [2/2]

◆ m_bufferSize

◆ m_detStore

◆ m_device

◆ m_DeviceMgmtSvc

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_inputDataStreamKeys

◆ m_kernelDefinitionsJsonString

◆ m_kernels

◆ m_outputDataStreamKeys

◆ m_runs

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_vsizes

◆ m_xclbinPath