Class for the data preparation pipeline. More...

#include <DataPreparationPipeline.h>

Inheritance diagram for DataPreparationPipeline:

Collaboration diagram for DataPreparationPipeline:

Public Member Functions
StatusCode	initialize () override final
	Detect the OpenCL devices and prepare OpenCL context. More...

StatusCode	execute (const EventContext &ctx) const override final
	Should be overriden by derived classes to perform meaningful work. More...

StatusCode	setupBuffers ()

StatusCode	setupKernelArgs ()

StatusCode	loadProgram (const std::string &xclbin)
	Find the xclbin file and load it into the OpenCL program object. More...

StatusCode	precheck (const std::vector< Gaudi::Property< std::string >> &inputs) const
	Check if the the desired Gaudi properties are set. More...

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

Protected Attributes
cl::Device	m_accelerator
	Device object for the accelerator card. More...

cl::Context	m_context
	Context object for the application. More...

cl::Program	m_program
	Program object containing the kernel. More...

Gaudi::Property< std::string >	m_deviceBDF {this, "bdfID", "", "BDF ID of the accelerator card"}
	BDF ID of the accelerator card. 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
cl::Kernel	m_pixelClusteringKernel
	Kernel for pixel clustering. More...

cl::Kernel	m_spacepointKernel
	Kernel for spacepoint. More...

cl::Buffer	m_pxlClusteringInBuff
	Buffer for pixel clustering input. More...

cl::Buffer	m_pxlClusteringOutBuff
	Buffer for pixel clustering output. More...

cl::Buffer	m_spacepointInBuff
	Buffer for spacepoint input. More...

cl::Buffer	m_spacepointOutBuff
	Buffer for spacepoint output. More...

Gaudi::Property< std::string >	m_xclbin
	Path and name of the xclbin file. More...

Gaudi::Property< std::string >	m_passThroughKernelName
	Pass through kernel name. More...

Gaudi::Property< std::string >	m_pixelClusteringKernelName
	Pixle clustering kernel name. More...

Gaudi::Property< std::string >	m_spacepointKernelName
	Spacepoint kernel name. More...

Gaudi::Property< std::string >	m_pixelClusterTVPath
	Pixel cluster test vector. More...

Gaudi::Property< std::string >	m_pixelClusterRefTVPath
	Pixel cluster reference test vector. More...

Gaudi::Property< std::string >	m_spacepointTVPath
	Spacepoint test vector. More...

Gaudi::Property< std::string >	m_spacepointRefTVPath
	Spacepoint reference test vector. More...

Gaudi::Property< bool >	m_usePassThrough
	Use the pass through tool instead of data prep pipeline. More...

Gaudi::Property< bool >	m_useTV {this, "UseTV", false, "Use test vector"}
	Use test vector. More...

ToolHandle< xAODClusterMaker >	m_xAODClusterMaker
	Tool handle for xAODClusterMaker. More...

ToolHandle< xAODSpacePointMaker >	m_xAODSpacePointMaker
	Tool handle for xAODSpacePointMaker. More...

ToolHandle< PassThroughTool >	m_passThroughTool
	Tool handle for PassThroughTool. More...

ToolHandle< TestVectorTool >	m_testVectorTool
	Tool handle for TestVectorTool. More...

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

Class for the data preparation pipeline.

Author: zhaoy.nosp@m.uan..nosp@m.cui@c.nosp@m.ern..nosp@m.ch; yuan-.nosp@m.tang.nosp@m..chou.nosp@m.@cer.nosp@m.n.ch

Date: Feb. 18, 2024

This is the class for the data preparation pipeline.

The output of this pipeline are the xAOD::StripCluster(Container) and xAOD::PixelCluster(Container). These containers are to be used in other CPU-based algorithms.

Definition at line 36 of file DataPreparationPipeline.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

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 DataPreparationPipeline::execute ( const EventContext & ctx ) const

finaloverridevirtual

Should be overriden by derived classes to perform meaningful work.

Reimplemented from IntegrationBase.

Definition at line 67 of file DataPreparationPipeline.cxx.

 {
   if (m_usePassThrough)
   {
     EFTrackingTransient::StripClusterAuxInput scAux;
     EFTrackingTransient::PixelClusterAuxInput pxAux;
     
     // Create separate structures for pixel and strip space points
     EFTrackingTransient::SpacePointAuxInput pixelSpAux;
     EFTrackingTransient::SpacePointAuxInput stripSpAux;
     
     std::unique_ptr<EFTrackingTransient::Metadata> metadata =
         std::make_unique<EFTrackingTransient::Metadata>();
  
     // Pass both aux structures to the PassThroughTool
     ATH_CHECK(m_passThroughTool->runPassThrough(scAux, pxAux, stripSpAux, pixelSpAux, metadata.get(), ctx));
     ATH_CHECK(m_xAODClusterMaker->makeStripClusterContainer(scAux, metadata.get(), ctx));
     ATH_CHECK(m_xAODClusterMaker->makePixelClusterContainer(pxAux, metadata.get(), ctx));
  
     ATH_CHECK(m_xAODSpacePointMaker->makeStripSpacePointContainer(stripSpAux, metadata.get(), ctx));
     ATH_CHECK(m_xAODSpacePointMaker->makePixelSpacePointContainer(pixelSpAux, metadata.get(), ctx));
  
     return StatusCode::SUCCESS;
   }
  
   // HW kernels to be added here in the future
   ATH_MSG_INFO("Running the FPGA Data Preparation Pipeline");
  
   // Order of execution
   // 1. Pixel/strip clustering
   // 2. Pixel/strip L2G
   // 3. Pixel/strip Spacepoint
  
   // Are we using TV or RDO?
   if (m_useTV)
   {
     // Make queue of commands
     cl::CommandQueue acc_queue(m_context, m_accelerator);
  
     ATH_MSG_INFO("Using test vectors");
     EFTrackingFPGAIntegration::TVHolder pixelTV("PixelClustering");
     ATH_CHECK(m_testVectorTool->prepareTV(m_pixelClusterTVPath, pixelTV.inputTV));
     ATH_CHECK(m_testVectorTool->prepareTV(m_pixelClusterRefTVPath, pixelTV.refTV));
  
     std::vector<uint64_t> fpgaOutput(pixelTV.inputTV.size() * 2, 0);
  
     ATH_MSG_INFO("Running the pixel clustering kernel");
     acc_queue.enqueueWriteBuffer(m_pxlClusteringInBuff, CL_TRUE, 0, sizeof(uint64_t) * pixelTV.inputTV.size(), pixelTV.inputTV.data(), NULL, NULL);
     acc_queue.enqueueTask(m_pixelClusteringKernel);
     acc_queue.finish();
  
     // The current implementation of the kernel Read/Write the same buffer
     // So the line below reads the inbuff insatead of outbuff
     acc_queue.enqueueReadBuffer(m_pxlClusteringInBuff, CL_TRUE, 0, sizeof(uint64_t) * fpgaOutput.size(), fpgaOutput.data(), NULL, NULL);
  
     // compare the output with the reference
     ATH_CHECK(m_testVectorTool->compare(pixelTV, fpgaOutput));
  
     // do the same for spacepoint
     EFTrackingFPGAIntegration::TVHolder spacepointTV("Spacepoint");
     ATH_CHECK(m_testVectorTool->prepareTV(m_spacepointTVPath, spacepointTV.inputTV));
     ATH_CHECK(m_testVectorTool->prepareTV(m_spacepointRefTVPath, spacepointTV.refTV));
  
     // reset the output vector
     fpgaOutput = std::vector<uint64_t>(spacepointTV.inputTV.size() * 2, 0);
  
     ATH_MSG_INFO("Running the spacepoint kernel");
     acc_queue.enqueueWriteBuffer(m_spacepointInBuff, CL_TRUE, 0, sizeof(uint64_t) * spacepointTV.inputTV.size(), spacepointTV.inputTV.data(), NULL, NULL);
     acc_queue.enqueueTask(m_spacepointKernel);
     acc_queue.finish();
  
     acc_queue.enqueueReadBuffer(m_spacepointInBuff, CL_TRUE, 0, sizeof(uint64_t) * fpgaOutput.size(), fpgaOutput.data(), NULL, NULL);
  
     // compare the output with the reference
     ATH_CHECK(m_testVectorTool->compare(spacepointTV, fpgaOutput));
   }
   else
   {
     // Use FPGADataFormatTool to prepare input
     ATH_MSG_INFO("Using RDOs for FPGA is not ready yet");
   }
  
   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 DataPreparationPipeline::initialize ( )

finaloverridevirtual

Detect the OpenCL devices and prepare OpenCL context.

This should always be called by derived classes when running on the FPGA accelerator.

Reimplemented from IntegrationBase.

Definition at line 17 of file DataPreparationPipeline.cxx.

 {
   // Check if we are using the pass through tool
   // If yes, check if we are running in software mode. sw mode doesn't require an accelerator
   if (m_usePassThrough)
   {
     ATH_CHECK(m_passThroughTool.retrieve());
     if (m_passThroughTool->runSW())
     {
       ATH_MSG_INFO("Running software pass through");
     }
     else
     {
       ATH_MSG_INFO("Running hardware pass through");
       ATH_CHECK(IntegrationBase::precheck({m_xclbin, m_passThroughKernelName}));
       ATH_CHECK(IntegrationBase::initialize());
       ATH_CHECK(IntegrationBase::loadProgram(m_xclbin));
     }
   }
   // We are doing the Data Preparation Pipeline on FPGA, so we need to setup hardware
   else
   {
     ATH_MSG_INFO("Running the DataPrep pipeline on the FPGA accelerator");
     ATH_CHECK(IntegrationBase::precheck({m_xclbin, m_pixelClusteringKernelName, m_spacepointKernelName}));
     ATH_CHECK(IntegrationBase::initialize());
     ATH_CHECK(IntegrationBase::loadProgram(m_xclbin));
  
     // Kernel objects shouldn't change so they can be initialized here
     m_pixelClusteringKernel = cl::Kernel(m_program, m_pixelClusteringKernelName.value().data());
     m_spacepointKernel = cl::Kernel(m_program, m_spacepointKernelName.value().data());
  
     ATH_CHECK(setupBuffers());
     ATH_CHECK(setupKernelArgs());
  
     if (m_useTV)
     {
       ATH_CHECK(IntegrationBase::precheck({m_pixelClusterTVPath,
                                            m_pixelClusterRefTVPath,
                                            m_spacepointTVPath,
                                            m_spacepointRefTVPath}));
       ATH_CHECK(m_testVectorTool.retrieve());
     }
   }
  
   ATH_CHECK(m_xAODClusterMaker.retrieve());
   ATH_CHECK(m_xAODSpacePointMaker.retrieve());
  
   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;
 }

◆ loadProgram()

StatusCode IntegrationBase::loadProgram ( const std::string & xclbin )

inherited

Find the xclbin file and load it into the OpenCL program object.

Definition at line 102 of file IntegrationBase.cxx.

 {
     // Open binary object in binary mode
     std::ifstream bin_file(xclbin, std::ios_base::binary);
     if (!bin_file)
     {
         ATH_MSG_ERROR("Couldn't find the xclbin file: " << xclbin);
         return StatusCode::FAILURE;
     }
     // Get the size of the binary file
     bin_file.seekg(0, bin_file.end);
     unsigned bin_size = bin_file.tellg();
     // Reset the reference point back to the beginning
     bin_file.seekg(0, bin_file.beg);
     // Create a new pointer for the binary buffer and get the set a pointer to the binary buffer
     std::vector<char> buf(bin_size);
     bin_file.read(buf.data(), bin_size);
  
     // Create binary object and program object
     cl_int err = 0;
     std::vector<cl_int> binaryStatus;
     cl::Program::Binaries bins{{buf.data(), bin_size}};
     m_program = cl::Program(m_context, {m_accelerator}, bins, &binaryStatus, &err);
  
     bin_file.close();
  
     if (err == CL_SUCCESS && binaryStatus.at(0) == CL_SUCCESS)
     {
         ATH_MSG_INFO("Successfully loaded xclbin file into " << m_accelerator.getInfo<CL_DEVICE_NAME>());
     }
     else
     {
         ATH_MSG_ERROR("Error loading xclbin file (" << xclbin << ") into " << m_accelerator.getInfo<CL_DEVICE_NAME>() <<". Error code: " << err);
         return StatusCode::FAILURE;
     }
  
     return StatusCode::SUCCESS;
 }

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

◆ precheck()

StatusCode IntegrationBase::precheck ( const std::vector< Gaudi::Property< std::string >> & inputs ) const

inherited

Check if the the desired Gaudi properties are set.

Definition at line 141 of file IntegrationBase.cxx.

 {
     for(const auto &item : inputs)
     {
         if(item.empty())
         {
             ATH_MSG_FATAL(item.documentation()<<" is empty. Please set it to a valid value");
             return StatusCode::FAILURE;
         }
     }
  
     // Always check if bdf is set
     if (m_deviceBDF.empty())
     {
         ATH_MSG_WARNING("Device BDF is not set. Using the first found accelerator card. Set property 'bdfID' to specify the BDF of the device.");
     }
  
     return StatusCode::SUCCESS;
 }

◆ 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 );
   }

◆ setupBuffers()

StatusCode DataPreparationPipeline::setupBuffers ( )

Definition at line 152 of file DataPreparationPipeline.cxx.

 {
   // Allocate buffers on accelerator
   cl_int err = 0;
  
   // Set the size of the buffer to be 100000, should be further discussed!
   unsigned int size = 100000;
   m_pxlClusteringInBuff = cl::Buffer(m_context, CL_MEM_READ_ONLY, sizeof(uint64_t) * size, NULL, &err);
   if (err != CL_SUCCESS)
   {
     ATH_MSG_ERROR("Failed to allocate intput buffer for pixel clustering");
     return StatusCode::FAILURE;
   }
  
   m_pxlClusteringOutBuff = cl::Buffer(m_context, CL_MEM_READ_WRITE, sizeof(uint64_t) * size, NULL, &err);
   if (err != CL_SUCCESS)
   {
     ATH_MSG_ERROR("Failed to allocate output buffer for pixel clustering");
     return StatusCode::FAILURE;
   }
  
   m_spacepointInBuff = cl::Buffer(m_context, CL_MEM_READ_ONLY, sizeof(uint64_t) * size, NULL, &err);
   if (err != CL_SUCCESS)
   {
     ATH_MSG_ERROR("Failed to allocate input buffer for spacepoint");
     return StatusCode::FAILURE;
   }
  
   m_spacepointOutBuff = cl::Buffer(m_context, CL_MEM_READ_WRITE, sizeof(uint64_t) * size, NULL, &err);
   if (err != CL_SUCCESS)
   {
     ATH_MSG_ERROR("Failed to allocate output buffer for spacepoint");
     return StatusCode::FAILURE;
   }
  
   return StatusCode::SUCCESS;
 }

◆ setupKernelArgs()

StatusCode DataPreparationPipeline::setupKernelArgs ( )

Definition at line 190 of file DataPreparationPipeline.cxx.

 {
   // Prepare kernel
   m_pixelClusteringKernel.setArg<uint>(0, 0);
   m_pixelClusteringKernel.setArg<cl::Buffer>(1, m_pxlClusteringInBuff);
   m_pixelClusteringKernel.setArg<cl::Buffer>(2, m_pxlClusteringOutBuff);
  
   m_spacepointKernel.setArg<cl::Buffer>(0, m_spacepointInBuff);
   m_spacepointKernel.setArg<cl::Buffer>(1, m_spacepointOutBuff);
   // Hardcoded the size for now, shouldn't need the size eventually
   m_spacepointKernel.setArg<uint>(2, 33);
  
   return StatusCode::SUCCESS;
 }

◆ 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

◆ m_accelerator

cl::Device IntegrationBase::m_accelerator

protectedinherited

Device object for the accelerator card.

Definition at line 66 of file IntegrationBase.h.

◆ m_context

cl::Context IntegrationBase::m_context

protectedinherited

Context object for the application.

Definition at line 67 of file IntegrationBase.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_deviceBDF

Gaudi::Property<std::string> IntegrationBase::m_deviceBDF {this, "bdfID", "", "BDF ID of the accelerator card"}

protectedinherited

BDF ID of the accelerator card.

Definition at line 69 of file IntegrationBase.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_passThroughKernelName

Gaudi::Property<std::string> DataPreparationPipeline::m_passThroughKernelName

private

Initial value:

{this,
                                                         "PassThroughKernelName", "",
                                                         "Pass through kernel name"}

Pass through kernel name.

Definition at line 61 of file DataPreparationPipeline.h.

◆ m_passThroughTool

ToolHandle<PassThroughTool> DataPreparationPipeline::m_passThroughTool

private

Initial value:

{
        this, "PassThroughTool", "PassThroughTool",
        "The pass through tool"}

Tool handle for PassThroughTool.

Definition at line 97 of file DataPreparationPipeline.h.

◆ m_pixelClusteringKernel

cl::Kernel DataPreparationPipeline::m_pixelClusteringKernel

private

Kernel for pixel clustering.

Definition at line 48 of file DataPreparationPipeline.h.

◆ m_pixelClusteringKernelName

Gaudi::Property<std::string> DataPreparationPipeline::m_pixelClusteringKernelName

private

Initial value:

{this,
                                                             "PixelClusteringKernelName", "",
                                                             "Pixel Clustering kernel name"}

Pixle clustering kernel name.

Definition at line 64 of file DataPreparationPipeline.h.

◆ m_pixelClusterRefTVPath

Gaudi::Property<std::string> DataPreparationPipeline::m_pixelClusterRefTVPath

private

Initial value:

{this, "PixelClusterRefTV", "",

"Path to pixel cluster reference test vector"}

Pixel cluster reference test vector.

Definition at line 74 of file DataPreparationPipeline.h.

◆ m_pixelClusterTVPath

Gaudi::Property<std::string> DataPreparationPipeline::m_pixelClusterTVPath

private

Initial value:

{this, "PixelClusterTV", "",

"Path to pixel cluster test vector"}

Pixel cluster test vector.

Definition at line 72 of file DataPreparationPipeline.h.

◆ m_program

cl::Program IntegrationBase::m_program

protectedinherited

Program object containing the kernel.

Definition at line 68 of file IntegrationBase.h.

◆ m_pxlClusteringInBuff

cl::Buffer DataPreparationPipeline::m_pxlClusteringInBuff

private

Buffer for pixel clustering input.

Definition at line 51 of file DataPreparationPipeline.h.

◆ m_pxlClusteringOutBuff

cl::Buffer DataPreparationPipeline::m_pxlClusteringOutBuff

private

Buffer for pixel clustering output.

Definition at line 52 of file DataPreparationPipeline.h.

◆ m_spacepointInBuff

cl::Buffer DataPreparationPipeline::m_spacepointInBuff

private

Buffer for spacepoint input.

Definition at line 54 of file DataPreparationPipeline.h.

◆ m_spacepointKernel

cl::Kernel DataPreparationPipeline::m_spacepointKernel

private

Kernel for spacepoint.

Definition at line 49 of file DataPreparationPipeline.h.

◆ m_spacepointKernelName

Gaudi::Property<std::string> DataPreparationPipeline::m_spacepointKernelName

private

Initial value:

{this,
                                                        "SpacepointKernelName", "",
                                                        "Spacepoint kernel name"}

Spacepoint kernel name.

Definition at line 67 of file DataPreparationPipeline.h.

◆ m_spacepointOutBuff

cl::Buffer DataPreparationPipeline::m_spacepointOutBuff

private

Buffer for spacepoint output.

Definition at line 55 of file DataPreparationPipeline.h.

◆ m_spacepointRefTVPath

Gaudi::Property<std::string> DataPreparationPipeline::m_spacepointRefTVPath

private

Initial value:

{this, "SpacepointRefTV", "",

"Path to spacepoint reference test vector"}

Spacepoint reference test vector.

Definition at line 79 of file DataPreparationPipeline.h.

◆ m_spacepointTVPath

Gaudi::Property<std::string> DataPreparationPipeline::m_spacepointTVPath

private

Initial value:

{this, "SpacepointTV", "",

"Path to spacepoint test vector"}

Spacepoint test vector.

Definition at line 77 of file DataPreparationPipeline.h.

◆ m_testVectorTool

ToolHandle<TestVectorTool> DataPreparationPipeline::m_testVectorTool

private

Initial value:

{
        this, "TestVectorTool", "TestVectorTool",
        "Tool to prepare test vector"}

Tool handle for TestVectorTool.

Definition at line 101 of file DataPreparationPipeline.h.

◆ m_usePassThrough

Gaudi::Property<bool> DataPreparationPipeline::m_usePassThrough

private

Initial value:

{
        this, "RunPassThrough", false,
        "Use the passthrough tool instead of data prep pipeline"}

Use the pass through tool instead of data prep pipeline.

It can be either sw or hw, setting in the tool

Definition at line 83 of file DataPreparationPipeline.h.

◆ m_useTV

Gaudi::Property<bool> DataPreparationPipeline::m_useTV {this, "UseTV", false, "Use test vector"}

private

Use test vector.

Definition at line 86 of file DataPreparationPipeline.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_xAODClusterMaker

ToolHandle<xAODClusterMaker> DataPreparationPipeline::m_xAODClusterMaker

private

Initial value:

{
        this, "xAODClusterMaker", "xAODClusterMaker",
        "tool to make cluster"}

Tool handle for xAODClusterMaker.

Definition at line 89 of file DataPreparationPipeline.h.

◆ m_xAODSpacePointMaker

ToolHandle<xAODSpacePointMaker> DataPreparationPipeline::m_xAODSpacePointMaker

private

Initial value:

{
        this, "xAODSpacePointMaker", "xAODSpacePointMaker",
        "tool to make space point"}

Tool handle for xAODSpacePointMaker.

Definition at line 93 of file DataPreparationPipeline.h.

◆ m_xclbin

Gaudi::Property<std::string> DataPreparationPipeline::m_xclbin

private

Initial value:

{
        this, "xclbin", "",
        "xclbin path and name"}

Path and name of the xclbin file.

Definition at line 58 of file DataPreparationPipeline.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

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()

◆ loadProgram()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ precheck()

◆ renounce()

◆ renounceArray()

◆ setFilterPassed()

◆ setupBuffers()

◆ setupKernelArgs()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_accelerator

◆ m_context

◆ m_detStore

◆ m_deviceBDF

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_passThroughKernelName

◆ m_passThroughTool

◆ m_pixelClusteringKernel

◆ m_pixelClusteringKernelName

◆ m_pixelClusterRefTVPath

◆ m_pixelClusterTVPath

◆ m_program

◆ m_pxlClusteringInBuff

◆ m_pxlClusteringOutBuff

◆ m_spacepointInBuff

◆ m_spacepointKernel

◆ m_spacepointKernelName

◆ m_spacepointOutBuff

◆ m_spacepointRefTVPath

◆ m_spacepointTVPath

◆ m_testVectorTool

◆ m_usePassThrough

◆ m_useTV

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_xAODClusterMaker

◆ m_xAODSpacePointMaker

◆ m_xclbin