This is the class for the benchmark algorithm specific to the FPGA integration and output conversion. More...

#include <BenchmarkAlg.h>

Inheritance diagram for EFTrackingFPGAIntegration::BenchmarkAlg:

Collaboration diagram for EFTrackingFPGAIntegration::BenchmarkAlg:

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

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

virtual StatusCode	finalize () override final

StatusCode	runPassThrough (std::vector< uint64_t > &pixelChainOutput, std::vector< uint64_t > &stripChainOutput, const EventContext &ctx) const

StatusCode	runDataPrep (std::vector< uint64_t > &pixelChainOutput, std::vector< uint64_t > &stripChainOutput, const EventContext &ctx) const

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, V, H > &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...

Gaudi::Property< bool >	m_doEmulation {this, "doEmulation", false, "If software or hardware emulation is being used for debugging"}

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

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

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

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

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

Private Attributes
ServiceHandle< IChronoSvc >	m_chronoSvc
	Service for timing the algorithm. More...

ToolHandle< xAODClusterMaker >	m_xaodClusterMaker
	Tool for creating xAOD containers. More...

ToolHandle< TestVectorTool >	m_testVectorTool
	Tool for preparing test vectors. More...

ToolHandle< FPGADataFormatTool >	m_FPGADataFormatTool
	Tool for formatting FPGA data. More...

SG::ReadHandleKey< xAOD::PixelClusterContainer >	m_inputPixelClusterKey
	Key to access input pixel clusters. More...

SG::ReadHandleKey< xAOD::StripClusterContainer >	m_inputStripClusterKey
	Key to access input strip clusters. More...

SG::ReadHandleKey< PixelRDO_Container >	m_pixelRDOKey {this, "PixelRDO", "ITkPixelRDOs"}

SG::ReadHandleKey< SCT_RDO_Container >	m_stripRDOKey {this, "StripRDO", "ITkStripRDOs"}

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

Gaudi::Property< std::string >	m_edmKernelName
	Name of the FPGA kernel. More...

Gaudi::Property< std::string >	m_pixelClusterKernelName
	Name of the pixel clustering kernel. More...

Gaudi::Property< std::string >	m_stripClusterKernelName
	Name of the strip clustering kernel. More...

Gaudi::Property< std::string >	m_pixelL2GKernelName
	Name of the pixel L2G kernel. More...

Gaudi::Property< std::string >	m_stripL2GKernelName
	Name of the strip L2G kernelS. More...

Gaudi::Property< bool >	m_runPassThrough
	Run the pass-through kernel. More...

std::atomic< ulonglong >	m_numEvents {0}
	Number of events processed. More...

std::atomic< cl_ulong >	m_pixelInputTime {0}
	Time for pixel input buffer write. More...

std::atomic< cl_ulong >	m_stripInputTime {0}
	Time for strip input buffer write. More...

std::atomic< cl_ulong >	m_pixelClusteringTime {0}
	Time for pixel clustering. More...

std::atomic< cl_ulong >	m_stripClusteringTime {0}
	Time for strip clustering. More...

std::atomic< cl_ulong >	m_pixelL2GTime {0}
	Time for pixel L2G. More...

std::atomic< cl_ulong >	m_stripL2GTime {0}
	Time for strip L2G. More...

std::atomic< cl_ulong >	m_edmPrepTime {0}
	Time for EDM preparation. More...

std::atomic< cl_ulong >	m_pixelOutputTime {0}
	Time for pixel output buffer read. More...

std::atomic< cl_ulong >	m_stripOutputTime {0}
	Time for strip output buffer read. More...

std::atomic< cl_ulong >	m_kernelTime {0}
	Time for kernel execution. 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

This is the class for the benchmark algorithm specific to the FPGA integration and output conversion.

This algorithm is used to benchmark and optimize the FPGA output memory migration and output conversion. It expects the use of FPGA pass-through kernel.

Definition at line 35 of file BenchmarkAlg.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, V, H > &	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, 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());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	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, V, H > &	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, 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< 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 EFTrackingFPGAIntegration::BenchmarkAlg::execute ( const EventContext & ctx ) const

finaloverridevirtual

Should be overriden by derived classes to perform meaningful work.

Reimplemented from IntegrationBase.

Definition at line 46 of file BenchmarkAlg.cxx.

     {
         ATH_MSG_DEBUG("Executing BenchmarkAlg");
         m_numEvents++;
  
         // Create host side output vectors
         std::vector<uint64_t> pixelOutput(EFTrackingTransient::PIXEL_CONTAINER_BUF_SIZE, 0);
         std::vector<uint64_t> stripOutput(EFTrackingTransient::STRIP_CONTAINER_BUF_SIZE, 0);
  
         if (m_runPassThrough)
         {
             ATH_CHECK(runPassThrough(pixelOutput, stripOutput, ctx));
         }
         else // using the actual FPGA kernel chain
         {
             ATH_CHECK(runDataPrep(pixelOutput, stripOutput, ctx));
         }
  
         // use 64-bit pointer to access output
         uint64_t *stripClusters = stripOutput.data();
         uint64_t *pixelClusters = pixelOutput.data();
  
         unsigned int numStripClusters = stripClusters[0];
         ATH_MSG_DEBUG("numStripClusters: " << numStripClusters);
  
         unsigned int numPixelClusters = pixelClusters[0];
         ATH_MSG_DEBUG("numPixelClusters: " << numPixelClusters);
  
         std::unique_ptr<EFTrackingTransient::Metadata> metadata =
             std::make_unique<EFTrackingTransient::Metadata>();
  
         metadata->numOfStripClusters = numStripClusters;
         metadata->scRdoIndexSize = numStripClusters;
         metadata->numOfPixelClusters = numPixelClusters;
         metadata->pcRdoIndexSize = numPixelClusters;
  
         // make strip cluster
         ATH_CHECK(m_xaodClusterMaker->makeStripClusterContainer(stripClusters, metadata.get(), ctx));
  
         // Make pixel cluster
         ATH_CHECK(m_xaodClusterMaker->makePixelClusterContainer(pixelClusters, metadata.get(), ctx));
  
         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();
   }

◆ finalize()

StatusCode EFTrackingFPGAIntegration::BenchmarkAlg::finalize ( )

finaloverridevirtual

Definition at line 346 of file BenchmarkAlg.cxx.

     {
         if (!m_runPassThrough)
         {
             ATH_MSG_INFO("Finalizing BenchmarkAlg");
             ATH_MSG_INFO("Number of events: " << m_numEvents);
             ATH_MSG_INFO("Pixel input time: " << m_pixelInputTime / m_numEvents / 1e6 << " ms");
             ATH_MSG_INFO("Strip input time: " << m_stripInputTime / m_numEvents / 1e6 << " ms");
             ATH_MSG_INFO("Pixel clustering time: " << m_pixelClusteringTime / m_numEvents / 1e6 << " ms");
             ATH_MSG_INFO("Strip clustering time: " << m_stripClusteringTime / m_numEvents / 1e6 << " ms");
             ATH_MSG_INFO("Pixel L2G time: " << m_pixelL2GTime / m_numEvents / 1e6 << " ms");
             ATH_MSG_INFO("Strip L2G time: " << m_stripL2GTime / m_numEvents / 1e6 << " ms");
             ATH_MSG_INFO("EDMPrep time: " << m_edmPrepTime / m_numEvents / 1e6 << " ms");
             ATH_MSG_INFO("Kernel execution time: " << m_kernelTime / m_numEvents / 1e6 << " ms");
             ATH_MSG_INFO("Pixel output time: " << m_pixelOutputTime / m_numEvents / 1e6 << " ms");
             ATH_MSG_INFO("Strip output time: " << m_stripOutputTime / m_numEvents / 1e6 << " ms");
         }
  
         return StatusCode::SUCCESS;
     }

◆ initialize()

StatusCode EFTrackingFPGAIntegration::BenchmarkAlg::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 BenchmarkAlg.cxx.

     {
         ATH_MSG_INFO("Running on the FPGA accelerator");
  
         ATH_CHECK(IntegrationBase::precheck({m_xclbin}));
  
         ATH_CHECK(m_chronoSvc.retrieve());
  
         {
             Athena::Chrono chrono("Platform and device initlize", m_chronoSvc.get());
             ATH_CHECK(IntegrationBase::initialize());
         }
  
         {
             Athena::Chrono chrono("CL::loadProgram", m_chronoSvc.get());
             ATH_CHECK(IntegrationBase::loadProgram(m_xclbin));
         }
         ATH_MSG_INFO("loading "<<m_xclbin);
         ATH_CHECK(m_inputPixelClusterKey.initialize());
         ATH_CHECK(m_inputStripClusterKey.initialize());
         ATH_CHECK(m_pixelRDOKey.initialize());
         ATH_CHECK(m_stripRDOKey.initialize());
  
         ATH_CHECK(m_xaodClusterMaker.retrieve());
         ATH_CHECK(m_testVectorTool.retrieve());
         ATH_CHECK(m_FPGADataFormatTool.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 115 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 154 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();
   }

◆ runDataPrep()

StatusCode EFTrackingFPGAIntegration::BenchmarkAlg::runDataPrep	(	std::vector< uint64_t > &	pixelChainOutput,
		std::vector< uint64_t > &	stripChainOutput,
		const EventContext &	ctx
	)		const

Definition at line 152 of file BenchmarkAlg.cxx.

     {
         ATH_MSG_DEBUG("Running DataPrep on FPGA");
         cl_int err = 0;
  
         // Get the RDOs from the SG
         auto pixelRDOHandle = SG::makeHandle(m_pixelRDOKey, ctx);
         auto stripRDOHandle = SG::makeHandle(m_stripRDOKey, ctx);
  
         // Encode RDO into byte stream
         std::vector<uint64_t> encodedPixelRDO;
         std::vector<uint64_t> encodedStripRDO;
  
         std::vector<IdentifierHash> listOfPixelIds;
         std::vector<IdentifierHash> listOfStripIds;
  
         // Encode RDOs into byte stream
         ATH_CHECK(m_FPGADataFormatTool->convertPixelHitsToFPGADataFormat(*pixelRDOHandle, encodedPixelRDO, listOfPixelIds, ctx));
         ATH_CHECK(m_FPGADataFormatTool->convertStripHitsToFPGADataFormat(*stripRDOHandle, encodedStripRDO, listOfStripIds, ctx));
  
         for (unsigned int i = 0; i < encodedPixelRDO.size(); i++)
         {
             ATH_MSG_DEBUG("Pixel RDO[" << i << "]: " << std::hex << encodedPixelRDO[i] << std::dec);
         }
         for (unsigned int i = 0; i < encodedStripRDO.size(); i++)
         {
             ATH_MSG_DEBUG("Strip RDO[" << i << "]: " << std::hex << encodedStripRDO[i] << std::dec);
         }
  
         // Create local CL buffers
         // Clustering
         cl::Buffer pixelClusterInputBuffer(m_context, CL_MEM_READ_ONLY, sizeof(uint64_t) * encodedPixelRDO.size(), NULL, &err);
         cl::Buffer stripClusterInputBuffer(m_context, CL_MEM_READ_ONLY, sizeof(uint64_t) * encodedStripRDO.size(), NULL, &err);
         cl::Buffer pixelClusterOutputBuffer(m_context, CL_MEM_READ_WRITE, EFTrackingTransient::PIXEL_BLOCK_BUF_SIZE * sizeof(uint64_t), NULL, &err); // Don't care in DataPrep
         cl::Buffer stripClusterOutputBuffer(m_context, CL_MEM_READ_WRITE, EFTrackingTransient::STRIP_BLOCK_BUF_SIZE * sizeof(uint64_t), NULL, &err); // Don't care in DataPrep
         cl::Buffer pixelClusterEDMOutputBuffer(m_context, CL_MEM_READ_WRITE,EFTrackingTransient::PIXEL_BLOCK_BUF_SIZE * sizeof(uint64_t), NULL, &err);
         cl::Buffer stripClusterEDMOutputBuffer(m_context, CL_MEM_READ_WRITE, EFTrackingTransient::STRIP_BLOCK_BUF_SIZE * sizeof(uint64_t), NULL, &err);
         // L2G
         cl::Buffer pixelL2GOutputBuffer(m_context, CL_MEM_READ_WRITE, EFTrackingTransient::PIXEL_BLOCK_BUF_SIZE * sizeof(uint64_t), NULL, &err); // Don't care in DataPrep
         cl::Buffer stripL2GOutputBuffer(m_context, CL_MEM_READ_WRITE, EFTrackingTransient::STRIP_BLOCK_BUF_SIZE * sizeof(uint64_t), NULL, &err); // Don't care in DataPrep
         cl::Buffer pixelL2GEDMOutputBuffer(m_context, CL_MEM_READ_WRITE, EFTrackingTransient::PIXEL_BLOCK_BUF_SIZE * sizeof(uint64_t), NULL, &err);
         cl::Buffer stripL2GEDMOutputBuffer(m_context, CL_MEM_READ_WRITE, EFTrackingTransient::STRIP_BLOCK_BUF_SIZE * sizeof(uint64_t), NULL, &err);
         // EDMPrep
         cl::Buffer edmPixelOutputBuffer(m_context, CL_MEM_READ_WRITE, EFTrackingTransient::PIXEL_CONTAINER_BUF_SIZE * sizeof(uint64_t), NULL, &err);
         cl::Buffer edmStripOutputBuffer(m_context, CL_MEM_READ_WRITE, EFTrackingTransient::STRIP_CONTAINER_BUF_SIZE * sizeof(uint64_t), NULL, &err);
  
         // Create local CL kernel objects
         // Clustering
         // Kernel names are hard-coded for the current development
         cl::Kernel pixelClusteringKernel(m_program, m_pixelClusterKernelName.value().data());
         pixelClusteringKernel.setArg<cl::Buffer>(0, pixelClusterInputBuffer);
         pixelClusteringKernel.setArg<cl::Buffer>(1, pixelClusterOutputBuffer);
         pixelClusteringKernel.setArg<cl::Buffer>(2, pixelClusterEDMOutputBuffer);
  
         cl::Kernel stripClusteringKernel(m_program, m_stripClusterKernelName.value().data());
         stripClusteringKernel.setArg<cl::Buffer>(0, stripClusterInputBuffer);
         stripClusteringKernel.setArg<cl::Buffer>(1, stripClusterOutputBuffer);
         stripClusteringKernel.setArg<cl::Buffer>(2, stripClusterEDMOutputBuffer);
         stripClusteringKernel.setArg<unsigned int>(3, encodedStripRDO.size());
  
         // L2G
         cl::Kernel pixelL2GKernel(m_program, m_pixelL2GKernelName.value().data());
         pixelL2GKernel.setArg<cl::Buffer>(0, pixelClusterOutputBuffer);
         pixelL2GKernel.setArg<cl::Buffer>(1, pixelClusterEDMOutputBuffer);
         pixelL2GKernel.setArg<cl::Buffer>(2, pixelL2GOutputBuffer);
         pixelL2GKernel.setArg<cl::Buffer>(3, pixelL2GEDMOutputBuffer);
  
         cl::Kernel stripL2GKernel(m_program, m_stripL2GKernelName.value().data());
         stripL2GKernel.setArg<cl::Buffer>(0, stripClusterOutputBuffer);
         stripL2GKernel.setArg<cl::Buffer>(1, stripClusterEDMOutputBuffer);
         stripL2GKernel.setArg<cl::Buffer>(2, stripL2GOutputBuffer);
         stripL2GKernel.setArg<cl::Buffer>(3, stripL2GEDMOutputBuffer);
  
         // Create EDMPrep kernel object and connect to buffers
         cl::Kernel edmPrepKernel(m_program, m_edmKernelName.value().data());
         edmPrepKernel.setArg<cl::Buffer>(0, pixelL2GEDMOutputBuffer);
         edmPrepKernel.setArg<cl::Buffer>(1, stripL2GEDMOutputBuffer);
         edmPrepKernel.setArg<cl::Buffer>(2, edmPixelOutputBuffer);
         edmPrepKernel.setArg<cl::Buffer>(3, edmStripOutputBuffer);
  
         cl::CommandQueue acc_queue(m_context, m_accelerator, CL_QUEUE_PROFILING_ENABLE, &err);
  
         cl::Event cl_evt_write_pixel_input;
         cl::Event cl_evt_write_strip_input;
         acc_queue.enqueueWriteBuffer(pixelClusterInputBuffer, CL_FALSE, 0, sizeof(uint64_t) * encodedPixelRDO.size(), encodedPixelRDO.data(), NULL, &cl_evt_write_pixel_input);
         acc_queue.enqueueWriteBuffer(stripClusterInputBuffer, CL_FALSE, 0, sizeof(uint64_t) * encodedStripRDO.size(), encodedStripRDO.data(), NULL, &cl_evt_write_strip_input);
         std::vector<cl::Event> cl_evt_vec_pixel_input{cl_evt_write_pixel_input};
         std::vector<cl::Event> cl_evt_vec_strip_input{cl_evt_write_strip_input};
         // Ideally, `finish` shouldn't be here because the kernels are invoked by event dependencies,
         // but we use this to temporarily enable kernel profiling.
         acc_queue.finish();
  
         cl::Event cl_evt_pixel_clustering;
         cl::Event cl_evt_strip_clustering;
         cl::Event cl_evt_pixel_l2g;
         cl::Event cl_evt_strip_l2g;
         cl::Event cl_evt_edm_prep;
         {
             Athena::Chrono chrono("Kernel execution", m_chronoSvc.get());
             acc_queue.enqueueTask(pixelClusteringKernel, &cl_evt_vec_pixel_input, &cl_evt_pixel_clustering);
             acc_queue.enqueueTask(stripClusteringKernel, &cl_evt_vec_strip_input, &cl_evt_strip_clustering);
  
             std::vector<cl::Event> cl_evt_vec_pixel_clustering{cl_evt_pixel_clustering};
             std::vector<cl::Event> cl_evt_vec_strip_clustering{cl_evt_strip_clustering};
             acc_queue.enqueueTask(pixelL2GKernel, &cl_evt_vec_pixel_clustering, &cl_evt_pixel_l2g);
             acc_queue.enqueueTask(stripL2GKernel, &cl_evt_vec_strip_clustering, &cl_evt_strip_l2g);
             std::vector<cl::Event> cl_evt_vec_l2g{cl_evt_pixel_l2g, cl_evt_strip_l2g};
  
             acc_queue.enqueueTask(edmPrepKernel, &cl_evt_vec_l2g, &cl_evt_edm_prep);
             // Ideally, `finish` shouldn't be here because the kernels are invoked by event dependencies,
             // but we use this to temporarily enable kernel profiling. CPU wall time
             acc_queue.finish();
         }
  
         cl::Event cl_evt_pixel_cluster_output;
         cl::Event cl_evt_strip_cluster_output;
         acc_queue.enqueueReadBuffer(edmPixelOutputBuffer, CL_FALSE, 0, sizeof(uint64_t) * pixelChainOutput.size(), pixelChainOutput.data(), NULL, &cl_evt_pixel_cluster_output);
         acc_queue.enqueueReadBuffer(edmStripOutputBuffer, CL_FALSE, 0, sizeof(uint64_t) * stripChainOutput.size(), stripChainOutput.data(), NULL, &cl_evt_strip_cluster_output);
         acc_queue.finish();
  
         // calculate the time for the kernel execution
         // get the time of writing pixel input buffer
         cl_ulong pixel_input_start = cl_evt_write_pixel_input.getProfilingInfo<CL_PROFILING_COMMAND_START>();
         cl_ulong pixel_input_end = cl_evt_write_pixel_input.getProfilingInfo<CL_PROFILING_COMMAND_END>();
         cl_ulong pixel_input_time = pixel_input_end - pixel_input_start;
         m_pixelInputTime += pixel_input_time;
         ATH_MSG_DEBUG("Pixel input buffer write time: " << pixel_input_time / 1e6 << " ms");
  
         // get the time of writing strip input buffer
         cl_ulong strip_input_start = cl_evt_write_strip_input.getProfilingInfo<CL_PROFILING_COMMAND_START>();
         cl_ulong strip_input_end = cl_evt_write_strip_input.getProfilingInfo<CL_PROFILING_COMMAND_END>();
         cl_ulong strip_input_time = strip_input_end - strip_input_start;
         m_stripInputTime += strip_input_time;
         ATH_MSG_DEBUG("Strip input buffer write time: " << strip_input_time / 1e6 << " ms");
  
         // get the time of pixel clustering
         cl_ulong pixel_clustering_start = cl_evt_pixel_clustering.getProfilingInfo<CL_PROFILING_COMMAND_START>();
         cl_ulong pixel_clustering_end = cl_evt_pixel_clustering.getProfilingInfo<CL_PROFILING_COMMAND_END>();
         cl_ulong pixel_clustering_time = pixel_clustering_end - pixel_clustering_start;
         m_pixelClusteringTime += pixel_clustering_time;
         ATH_MSG_DEBUG("Pixel clustering time: " << pixel_clustering_time / 1e6 << " ms");
  
         // get the time of strip clustering
         cl_ulong strip_clustering_start = cl_evt_strip_clustering.getProfilingInfo<CL_PROFILING_COMMAND_START>();
         cl_ulong strip_clustering_end = cl_evt_strip_clustering.getProfilingInfo<CL_PROFILING_COMMAND_END>();
         cl_ulong strip_clustering_time = strip_clustering_end - strip_clustering_start;
         m_stripClusteringTime += strip_clustering_time;
         ATH_MSG_DEBUG("Strip clustering time: " << strip_clustering_time / 1e6 << " ms");
  
         // get the time of pixel L2G
         cl_ulong pixel_l2g_start = cl_evt_pixel_l2g.getProfilingInfo<CL_PROFILING_COMMAND_START>();
         cl_ulong pixel_l2g_end = cl_evt_pixel_l2g.getProfilingInfo<CL_PROFILING_COMMAND_END>();
         cl_ulong pixel_l2g_time = pixel_l2g_end - pixel_l2g_start;
         m_pixelL2GTime += pixel_l2g_time;
         ATH_MSG_DEBUG("Pixel L2G time: " << pixel_l2g_time / 1e6 << " ms");
  
         // get the time of strip L2G
         cl_ulong strip_l2g_start = cl_evt_strip_l2g.getProfilingInfo<CL_PROFILING_COMMAND_START>();
         cl_ulong strip_l2g_end = cl_evt_strip_l2g.getProfilingInfo<CL_PROFILING_COMMAND_END>();
         cl_ulong strip_l2g_time = strip_l2g_end - strip_l2g_start;
         m_stripL2GTime += strip_l2g_time;
         ATH_MSG_DEBUG("Strip L2G time: " << strip_l2g_time / 1e6 << " ms");
  
         // get the time of EDMPrep
         cl_ulong edm_prep_start = cl_evt_edm_prep.getProfilingInfo<CL_PROFILING_COMMAND_START>();
         cl_ulong edm_prep_end = cl_evt_edm_prep.getProfilingInfo<CL_PROFILING_COMMAND_END>();
         cl_ulong edm_prep_time = edm_prep_end - edm_prep_start;
         m_edmPrepTime += edm_prep_time;
         ATH_MSG_DEBUG("EDMPrep time: " << edm_prep_time / 1e6 << " ms");
  
         // get the time of the whole kernel execution
         cl_ulong kernel_start = cl_evt_pixel_clustering.getProfilingInfo<CL_PROFILING_COMMAND_QUEUED>();
         cl_ulong kernel_end = cl_evt_edm_prep.getProfilingInfo<CL_PROFILING_COMMAND_END>();
         cl_ulong kernel_time = kernel_end - kernel_start;
         m_kernelTime += kernel_time;
         ATH_MSG_DEBUG("Kernel execution time: " << kernel_time / 1e6 << " ms");
  
         // get the time of reading pixel output buffer
         cl_ulong pixel_output_start = cl_evt_pixel_cluster_output.getProfilingInfo<CL_PROFILING_COMMAND_START>();
         cl_ulong pixel_output_end = cl_evt_pixel_cluster_output.getProfilingInfo<CL_PROFILING_COMMAND_END>();
         cl_ulong pixel_output_time = pixel_output_end - pixel_output_start;
         m_pixelOutputTime += pixel_output_time;
         ATH_MSG_DEBUG("Pixel output buffer read time: " << pixel_output_time / 1e6 << " ms");
  
         // get the time of reading strip output buffer
         cl_ulong strip_output_start = cl_evt_strip_cluster_output.getProfilingInfo<CL_PROFILING_COMMAND_START>();
         cl_ulong strip_output_end = cl_evt_strip_cluster_output.getProfilingInfo<CL_PROFILING_COMMAND_END>();
         cl_ulong strip_output_time = strip_output_end - strip_output_start;
         m_stripOutputTime += strip_output_time;
         ATH_MSG_DEBUG("Strip output buffer read time: " << strip_output_time / 1e6 << " ms");
  
         return StatusCode::SUCCESS;
     }

◆ runPassThrough()

StatusCode EFTrackingFPGAIntegration::BenchmarkAlg::runPassThrough	(	std::vector< uint64_t > &	pixelChainOutput,
		std::vector< uint64_t > &	stripChainOutput,
		const EventContext &	ctx
	)		const

Definition at line 91 of file BenchmarkAlg.cxx.

     {
         cl_int err = 0;
  
         // Load the ITk clusters from SG
         SG::ReadHandle<xAOD::StripClusterContainer> scContainerHandle(m_inputStripClusterKey, ctx);
         if (!scContainerHandle.isValid())
         {
             ATH_MSG_ERROR("Failed to retrieve: " << m_inputStripClusterKey);
             return StatusCode::FAILURE;
         }
  
         SG::ReadHandle<xAOD::PixelClusterContainer> pcContainerHandle(m_inputPixelClusterKey, ctx);
         if (!pcContainerHandle.isValid())
         {
             ATH_MSG_ERROR("Failed to retrieve: " << m_inputPixelClusterKey);
             return StatusCode::FAILURE;
         }
  
         // Encode ITK clusters into byte stream
         std::vector<uint64_t> encodedStripClusters;
         std::vector<uint64_t> encodedPixelClusters;
         ATH_CHECK(m_testVectorTool->encodeStripL2G(scContainerHandle.get(), encodedStripClusters));
         ATH_CHECK(m_testVectorTool->encodePixelL2G(pcContainerHandle.get(), encodedPixelClusters));
  
         // Create local CL buffers and kernel object for pixel and strip
         cl::Buffer inputPixelBuffer(m_context, CL_MEM_READ_ONLY, EFTrackingTransient::PIXEL_BLOCK_BUF_SIZE * sizeof(uint64_t), NULL, &err);
         cl::Buffer inputStripBuffer(m_context, CL_MEM_READ_ONLY, EFTrackingTransient::STRIP_BLOCK_BUF_SIZE * sizeof(uint64_t), NULL, &err);
         cl::Buffer outputPixelBuffer(m_context, CL_MEM_READ_WRITE, EFTrackingTransient::PIXEL_CONTAINER_BUF_SIZE * sizeof(uint64_t), NULL, &err);
         cl::Buffer outputStripBuffer(m_context, CL_MEM_READ_WRITE, EFTrackingTransient::STRIP_CONTAINER_BUF_SIZE * sizeof(uint64_t), NULL, &err);
  
         cl::Kernel kernel(m_program, m_edmKernelName.value().data());
         kernel.setArg<cl::Buffer>(0, inputPixelBuffer);
         kernel.setArg<cl::Buffer>(1, inputStripBuffer);
         kernel.setArg<cl::Buffer>(2, outputPixelBuffer);
         kernel.setArg<cl::Buffer>(3, outputStripBuffer);
  
         // Migrate the input test vectors to the accelerator
         cl::CommandQueue acc_queue(m_context, m_accelerator);
         acc_queue.enqueueWriteBuffer(inputPixelBuffer, CL_FALSE, 0, sizeof(uint64_t) * encodedPixelClusters.size(), encodedPixelClusters.data(), NULL, NULL);
         acc_queue.enqueueWriteBuffer(inputStripBuffer, CL_FALSE, 0, sizeof(uint64_t) * encodedStripClusters.size(), encodedStripClusters.data(), NULL, NULL);
         acc_queue.finish();
  
         // enqueue the kernel
         {
             Athena::Chrono chrono("EDMPrep kernel execution", m_chronoSvc.get());
             acc_queue.enqueueTask(kernel);
             acc_queue.finish();
         }
  
         // Read back the results
         {
             Athena::Chrono chrono("Read buffers", m_chronoSvc.get());
             acc_queue.enqueueReadBuffer(outputPixelBuffer, CL_FALSE, 0, sizeof(uint64_t) * pixelChainOutput.size(), pixelChainOutput.data(), NULL, NULL);
             acc_queue.enqueueReadBuffer(outputStripBuffer, CL_FALSE, 0, sizeof(uint64_t) * stripChainOutput.size(), stripChainOutput.data(), NULL, NULL);
             acc_queue.finish();
         }
  
         return StatusCode::SUCCESS;
     }

◆ 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

◆ m_accelerator

cl::Device IntegrationBase::m_accelerator

protectedinherited

Device object for the accelerator card.

Definition at line 66 of file IntegrationBase.h.

◆ m_chronoSvc

ServiceHandle<IChronoSvc> EFTrackingFPGAIntegration::BenchmarkAlg::m_chronoSvc

private

Initial value:

{

"ChronoStatSvc", name()}

Service for timing the algorithm.

Definition at line 46 of file BenchmarkAlg.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_doEmulation

Gaudi::Property<bool> IntegrationBase::m_doEmulation {this, "doEmulation", false, "If software or hardware emulation is being used for debugging"}

protectedinherited

Definition at line 70 of file IntegrationBase.h.

◆ m_edmKernelName

Gaudi::Property<std::string> EFTrackingFPGAIntegration::BenchmarkAlg::m_edmKernelName

private

Initial value:

{

this, "EDMPrepKernelName", "", "Name of the FPGA kernel"}

Name of the FPGA kernel.

Definition at line 74 of file BenchmarkAlg.h.

◆ m_edmPrepTime

std::atomic<cl_ulong> EFTrackingFPGAIntegration::BenchmarkAlg::m_edmPrepTime {0}

mutableprivate

Time for EDM preparation.

Definition at line 99 of file BenchmarkAlg.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_FPGADataFormatTool

ToolHandle<FPGADataFormatTool> EFTrackingFPGAIntegration::BenchmarkAlg::m_FPGADataFormatTool

private

Initial value:

{

this, "FPGADataFormatTool", "FPGADataFormatTool", "Tool for formatting FPGA data"}

Tool for formatting FPGA data.

Definition at line 58 of file BenchmarkAlg.h.

◆ m_inputPixelClusterKey

SG::ReadHandleKey<xAOD::PixelClusterContainer> EFTrackingFPGAIntegration::BenchmarkAlg::m_inputPixelClusterKey

private

Initial value:

{

this, "InputPixelClusterKey", "ITkPixelClusters", "Key to access input pixel clusters"}

Key to access input pixel clusters.

Definition at line 61 of file BenchmarkAlg.h.

◆ m_inputStripClusterKey

SG::ReadHandleKey<xAOD::StripClusterContainer> EFTrackingFPGAIntegration::BenchmarkAlg::m_inputStripClusterKey

private

Initial value:

{

this, "InputStripClusterKey", "ITkStripClusters", "Key to access input strip clusters"}

Key to access input strip clusters.

Definition at line 64 of file BenchmarkAlg.h.

◆ m_kernelTime

std::atomic<cl_ulong> EFTrackingFPGAIntegration::BenchmarkAlg::m_kernelTime {0}

mutableprivate

Time for kernel execution.

Definition at line 102 of file BenchmarkAlg.h.

◆ m_numEvents

std::atomic<ulonglong> EFTrackingFPGAIntegration::BenchmarkAlg::m_numEvents {0}

mutableprivate

Number of events processed.

Definition at line 92 of file BenchmarkAlg.h.

◆ m_pixelClusteringTime

std::atomic<cl_ulong> EFTrackingFPGAIntegration::BenchmarkAlg::m_pixelClusteringTime {0}

mutableprivate

Time for pixel clustering.

Definition at line 95 of file BenchmarkAlg.h.

◆ m_pixelClusterKernelName

Gaudi::Property<std::string> EFTrackingFPGAIntegration::BenchmarkAlg::m_pixelClusterKernelName

private

Initial value:

{

this, "PixelClusterKernelName", "", "Name of the pixel clustering kernel"}

Name of the pixel clustering kernel.

Definition at line 77 of file BenchmarkAlg.h.

◆ m_pixelInputTime

std::atomic<cl_ulong> EFTrackingFPGAIntegration::BenchmarkAlg::m_pixelInputTime {0}

mutableprivate

Time for pixel input buffer write.

Definition at line 93 of file BenchmarkAlg.h.

◆ m_pixelL2GKernelName

Gaudi::Property<std::string> EFTrackingFPGAIntegration::BenchmarkAlg::m_pixelL2GKernelName

private

Initial value:

{

this, "PixelL2GKernelName", "", "Name of the pixel L2G kernel"}

Name of the pixel L2G kernel.

Definition at line 83 of file BenchmarkAlg.h.

◆ m_pixelL2GTime

std::atomic<cl_ulong> EFTrackingFPGAIntegration::BenchmarkAlg::m_pixelL2GTime {0}

mutableprivate

Time for pixel L2G.

Definition at line 97 of file BenchmarkAlg.h.

◆ m_pixelOutputTime

std::atomic<cl_ulong> EFTrackingFPGAIntegration::BenchmarkAlg::m_pixelOutputTime {0}

mutableprivate

Time for pixel output buffer read.

Definition at line 100 of file BenchmarkAlg.h.

◆ m_pixelRDOKey

SG::ReadHandleKey<PixelRDO_Container> EFTrackingFPGAIntegration::BenchmarkAlg::m_pixelRDOKey {this, "PixelRDO", "ITkPixelRDOs"}

private

Definition at line 67 of file BenchmarkAlg.h.

◆ m_program

cl::Program IntegrationBase::m_program

protectedinherited

Program object containing the kernel.

Definition at line 68 of file IntegrationBase.h.

◆ m_runPassThrough

Gaudi::Property<bool> EFTrackingFPGAIntegration::BenchmarkAlg::m_runPassThrough

private

Initial value:

{

this, "runPassThrough", true, "Run the pass-through kernel"}

Run the pass-through kernel.

Definition at line 89 of file BenchmarkAlg.h.

◆ m_stripClusteringTime

std::atomic<cl_ulong> EFTrackingFPGAIntegration::BenchmarkAlg::m_stripClusteringTime {0}

mutableprivate

Time for strip clustering.

Definition at line 96 of file BenchmarkAlg.h.

◆ m_stripClusterKernelName

Gaudi::Property<std::string> EFTrackingFPGAIntegration::BenchmarkAlg::m_stripClusterKernelName

private

Initial value:

{

this, "StripClusterKernelName", "", "Name of the strip clustering kernel"}

Name of the strip clustering kernel.

Definition at line 80 of file BenchmarkAlg.h.

◆ m_stripInputTime

std::atomic<cl_ulong> EFTrackingFPGAIntegration::BenchmarkAlg::m_stripInputTime {0}

mutableprivate

Time for strip input buffer write.

Definition at line 94 of file BenchmarkAlg.h.

◆ m_stripL2GKernelName

Gaudi::Property<std::string> EFTrackingFPGAIntegration::BenchmarkAlg::m_stripL2GKernelName

private

Initial value:

{

this, "StripL2GKernelName", "", "Name of the strip L2G kernel"}

Name of the strip L2G kernelS.

Definition at line 86 of file BenchmarkAlg.h.

◆ m_stripL2GTime

std::atomic<cl_ulong> EFTrackingFPGAIntegration::BenchmarkAlg::m_stripL2GTime {0}

mutableprivate

Time for strip L2G.

Definition at line 98 of file BenchmarkAlg.h.

◆ m_stripOutputTime

std::atomic<cl_ulong> EFTrackingFPGAIntegration::BenchmarkAlg::m_stripOutputTime {0}

mutableprivate

Time for strip output buffer read.

Definition at line 101 of file BenchmarkAlg.h.

◆ m_stripRDOKey

SG::ReadHandleKey<SCT_RDO_Container> EFTrackingFPGAIntegration::BenchmarkAlg::m_stripRDOKey {this, "StripRDO", "ITkStripRDOs"}

private

Definition at line 69 of file BenchmarkAlg.h.

◆ m_testVectorTool

ToolHandle<TestVectorTool> EFTrackingFPGAIntegration::BenchmarkAlg::m_testVectorTool

private

Initial value:

{

this, "TestVectorTool", "TestVectorTool", "Tool for preparing test vectors"}

Tool for preparing test vectors.

Definition at line 55 of file BenchmarkAlg.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> EFTrackingFPGAIntegration::BenchmarkAlg::m_xaodClusterMaker

private

Initial value:

{
            this,
            "xAODClusterMaker",
            "xAODClusterMaker",
            "Tool for creating xAOD cluster containers"}

Tool for creating xAOD containers.

Definition at line 49 of file BenchmarkAlg.h.

◆ m_xclbin

Gaudi::Property<std::string> EFTrackingFPGAIntegration::BenchmarkAlg::m_xclbin

private

Initial value:

{

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

Path and name of the xclbin file.

Definition at line 71 of file BenchmarkAlg.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()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ loadProgram()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ precheck()

◆ renounce()

◆ renounceArray()

◆ runDataPrep()

◆ runPassThrough()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_accelerator

◆ m_chronoSvc

◆ m_context

◆ m_detStore

◆ m_deviceBDF

◆ m_doEmulation

◆ m_edmKernelName

◆ m_edmPrepTime

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_FPGADataFormatTool

◆ m_inputPixelClusterKey

◆ m_inputStripClusterKey

◆ m_kernelTime

◆ m_numEvents

◆ m_pixelClusteringTime

◆ m_pixelClusterKernelName

◆ m_pixelInputTime

◆ m_pixelL2GKernelName

◆ m_pixelL2GTime

◆ m_pixelOutputTime

◆ m_pixelRDOKey

◆ m_program

◆ m_runPassThrough

◆ m_stripClusteringTime

◆ m_stripClusterKernelName

◆ m_stripInputTime

◆ m_stripL2GKernelName

◆ m_stripL2GTime

◆ m_stripOutputTime

◆ m_stripRDOKey

◆ m_testVectorTool