FPGAStripClustering Class Reference

Class for the strip clustering kernel. More...

#include <FPGAStripClustering.h>

Inheritance diagram for FPGAStripClustering:

Collaboration diagram for FPGAStripClustering:

Public Member Functions
StatusCode	initialize () override
	Implementation of strip clustering using FPGA acceleration.
StatusCode	execute (const EventContext &ctx) const override
	Should be overriden by derived classes to perform meaningful work.
StatusCode	loadProgram (const std::string &xclbin)
	Find the xclbin file and load it into the OpenCL program object.
StatusCode	precheck (const std::vector< Gaudi::Property< std::string > > &inputs) const
	Check if the the desired Gaudi properties are set.
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual bool	isClonable () const override
	Specify if the algorithm is clonable.
virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
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.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

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

Protected Attributes
cl::Device	m_accelerator
	Device object for the accelerator card.
cl::Context	m_context
	Context object for the application.
cl::Program	m_program
	Program object containing the kernel.
Gaudi::Property< std::string >	m_deviceBDF {this, "bdfID", "", "BDF ID of the accelerator card"}
	BDF ID of the accelerator card.
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>

Private Attributes
Gaudi::Property< std::string >	m_xclbin {this, "xclbin", "", "xclbin path and name"}
	Path and name of the xclbin file.
Gaudi::Property< std::string >	m_kernelName {this, "KernelName", "", "Kernel name"}
	Kernel name.
Gaudi::Property< std::string >	m_inputTV {this, "InputTV", "", "Input TestVector"}
	Input TestVector.
Gaudi::Property< std::string >	m_refTV {this, "RefTV", "", "Reference TestVector"}
	Reference TestVector.
SG::ReadHandleKey< SCT_RDO_Container >	m_stripRDOKey {this, "StripRDO", "ITkStripRDOs", "Input data for strip clustering"}
	Input data key.
ToolHandle< FPGADataFormatTool >	m_FPGADataFormatTool {this, "FPGADataFormatTool", "FPGADataFormatTool", "tool to convert RDOs into FPGA data format"}
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Class for the strip clustering kernel.

Date

Jan. 22, 2025

Definition at line 19 of file FPGAStripClustering.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 ( ) const

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

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

declareProperty()

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.

{ return m_detStore; }

evtStore()

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.

{ return m_evtStore; }

execute()

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

overridevirtual

Should be overriden by derived classes to perform meaningful work.

Reimplemented from IntegrationBase.

Definition at line 21 of file FPGAStripClustering.cxx.

                                                                     {
    ATH_MSG_DEBUG("Executing StripClustering for event slot: " << ctx.slot());
 
    // Handle input data
    auto stripRDOHandle = SG::makeHandle(m_stripRDOKey, ctx);
    if (!stripRDOHandle.isValid()) {
        ATH_MSG_ERROR("Failed to retrieve input data.");
        return StatusCode::FAILURE;
    }
    std::vector<IdentifierHash> listOfIds;
    std::vector<uint64_t> outputData;
    if (!m_FPGADataFormatTool->convertStripHitsToFPGADataFormat(*stripRDOHandle, outputData, listOfIds, ctx)) {
        ATH_MSG_ERROR("Failed to convert input data to FPGA-compatible format.");
        return StatusCode::FAILURE;
    }
 
    // Debug input data
    ATH_MSG_DEBUG("Encoded strip data size: " << outputData.size());
    int line = 0;
    for (const auto& var : outputData) {
        ATH_MSG_DEBUG("EncodedData[" << std::dec << std::setw(4) << line << "] = 0x" 
                      << std::hex << std::setfill('0') << std::setw(16) << var << std::setfill(' '));
        line++;
    }
 
    // Prepare output vector (same size as input data)
    std::vector<uint64_t> kernelOutput(outputData.size(), 0);
    std::vector<uint64_t> kernelEDMOutput(outputData.size()*10, 0);
    std::vector<uint64_t> kernel_L2GOutput(outputData.size(), 0);
    std::vector<uint64_t> kernel_L2GEDMOutput(outputData.size()*10, 0);
    std::vector<uint32_t> kernel_EDMPrepOutputPixel(outputData.size(), 0);
    // 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);
 
    ATH_MSG_DEBUG("strip buffer size: "<<std::dec <<EFTrackingTransient::STRIP_CONTAINER_BUF_SIZE);
 
    // Work with the FPGA accelerator
    cl_int err = 0;
 
    // Allocate buffers on the accelerator
    cl::Buffer inputBuffer(m_context, CL_MEM_READ_ONLY, sizeof(uint64_t) * outputData.size(), nullptr, &err);
    cl::Buffer outputBuffer(m_context, CL_MEM_READ_WRITE, sizeof(uint64_t) * kernelOutput.size(), nullptr, &err);
    cl::Buffer outputEDMBuffer(m_context, CL_MEM_READ_WRITE, sizeof(uint64_t) * kernelEDMOutput.size(), nullptr, &err);
 
    cl::Buffer output_L2GBuffer(m_context, CL_MEM_WRITE_ONLY, sizeof(uint64_t) * kernel_L2GOutput.size(), nullptr, &err);
    cl::Buffer output_L2GEDMBuffer(m_context, CL_MEM_READ_WRITE, sizeof(uint64_t) * kernel_L2GEDMOutput.size(), nullptr, &err);
 
 
    cl::Buffer inputBufferPixel(m_context, CL_MEM_READ_ONLY, sizeof(uint64_t) * outputData.size(), nullptr, &err);
    cl::Buffer output_EDMPrepBufferPixel(m_context, CL_MEM_WRITE_ONLY, sizeof(uint64_t) * kernel_EDMPrepOutputPixel.size(), nullptr, &err);
    
    cl::Buffer stripbuffer(m_context, CL_MEM_READ_WRITE, stripOutput.size() * sizeof(uint64_t), NULL, &err);
 
    // Prepare and configure the kernel
    cl::Kernel kernel(m_program, m_kernelName.value().c_str(), &err);
    kernel.setArg(0, inputBuffer);
    kernel.setArg(1, outputBuffer);
    kernel.setArg(2, outputEDMBuffer);
    kernel.setArg(3, static_cast<unsigned int>(outputData.size()));
 
    cl::Kernel kernel_L2G(m_program, "l2g_strip_tool", &err);
    kernel_L2G.setArg(0, outputBuffer);
    kernel_L2G.setArg(1, outputEDMBuffer);
    kernel_L2G.setArg(2, output_L2GBuffer);
    kernel_L2G.setArg(3, output_L2GEDMBuffer);
 
    cl::Kernel kernel_EMDPrep(m_program, "EDMPrep", &err);
    kernel_EMDPrep.setArg(0, inputBufferPixel);
    kernel_EMDPrep.setArg(1, output_L2GEDMBuffer);
    kernel_EMDPrep.setArg(2, output_EDMPrepBufferPixel);
    kernel_EMDPrep.setArg(3, stripbuffer);
 
 
    // Command queue for the accelerator
    cl::CommandQueue queue(m_context, m_accelerator, 0, &err);
 
    // Enqueue write, execute kernel, and read back results
    queue.enqueueWriteBuffer(inputBuffer, CL_TRUE, 0, sizeof(uint64_t) * outputData.size(), outputData.data());
    queue.enqueueTask(kernel);
    queue.finish();
    queue.enqueueTask(kernel_L2G);
    queue.finish();
    queue.enqueueTask(kernel_EMDPrep);
    queue.finish();
    queue.enqueueReadBuffer(outputBuffer, CL_TRUE, 0, sizeof(uint64_t) * kernelOutput.size(), kernelOutput.data());
    queue.enqueueReadBuffer(outputEDMBuffer, CL_TRUE, 0, sizeof(uint64_t) * kernelEDMOutput.size(), kernelEDMOutput.data());
    queue.enqueueReadBuffer(output_L2GBuffer, CL_TRUE, 0, sizeof(uint64_t) * kernel_L2GOutput.size(), kernel_L2GOutput.data());
    queue.enqueueReadBuffer(output_L2GEDMBuffer, CL_TRUE, 0, sizeof(uint64_t) * kernel_L2GEDMOutput.size(), kernel_L2GEDMOutput.data());
    queue.enqueueReadBuffer(stripbuffer, CL_TRUE, 0, stripOutput.size() * sizeof(uint64_t), stripOutput.data());
    queue.finish();
 
    // Debug output data
    ATH_MSG_DEBUG("Kernel execution completed.");
    line = 0;
    for (const auto& var : kernelOutput) {
        if(var != 0) ATH_MSG_DEBUG("Clustering KernelOutput[" << std::dec << std::setw(4) << line << "] = 0x" 
                      << std::hex << std::setfill('0') << std::setw(16) << var << std::setfill(' '));
        line++;
    }
    line = 0;
    for (const auto& var : kernelEDMOutput) {
        if(var != 0) ATH_MSG_DEBUG("Clustering KernelEDMOutput[" << std::dec << std::setw(4) << line << "] = 0x" 
                      << std::hex << std::setfill('0') << std::setw(16) << var << std::setfill(' '));
        line++;
    }
 
    line = 0;
    for (const auto& var : kernel_L2GOutput) {
        if(var != 0) ATH_MSG_DEBUG("L2G KernelOutput[" << std::dec << std::setw(4) << line << "] = 0x" 
                      << std::hex << std::setfill('0') << std::setw(16) << var << std::setfill(' '));
        line++;
    }
    line = 0;
    for (const auto& var : kernel_L2GEDMOutput) {
        if(var != 0) ATH_MSG_DEBUG("L2g KernelEDMOutput[" << std::dec << std::setw(4) << line << "] = 0x" 
                      << std::hex << std::setfill('0') << std::setw(16) << var << std::setfill(' '));
        line++;
    }
    line = 0;
    for (const auto& var : stripOutput) {
        if(var != 0) ATH_MSG_DEBUG("EDM Prep kernel_EMDPrep[" << std::dec << std::setw(4) << line << "] = 0x" 
                      << std::hex << std::setfill('0') << std::setw(16) << var << std::setfill(' '));
        line++;
    }
    ATH_MSG_DEBUG("Total lines: "<<std::dec<<line<<std::endl);
 
 
 
 
 
    // use 32-bit point to access output
    uint64_t *stripClusters = (uint64_t *)stripOutput.data();
 
    unsigned int numStripClusters = stripClusters[0];
    ATH_MSG_DEBUG("numStripClusters: " << numStripClusters);
 
 
    std::unique_ptr<EFTrackingTransient::Metadata> metadata =
        std::make_unique<EFTrackingTransient::Metadata>();
 
    metadata->numOfStripClusters = numStripClusters;
    metadata->scRdoIndexSize = numStripClusters;
 
    EFTrackingTransient::StripClusterAuxInput scAux;
 
    // Declare a few vairiables to be used in the loop
    int row = 0;
    uint64_t rdo;
    int rdoCounter = 0;
 
    // Make strip cluster aux input
    {
     for (unsigned int i = 0; i < numStripClusters; i++)
     {
         rdoCounter = 0;
         row = 0; // idhash
         scAux.idHash.push_back(stripClusters[row * EFTrackingTransient::MAX_NUM_CLUSTERS + i + 8]);
         row = 1; // id
         scAux.id.push_back(stripClusters[row * EFTrackingTransient::MAX_NUM_CLUSTERS + i + 8]);
         row = 2; // rdo w1
         rdo = stripClusters[row * EFTrackingTransient::MAX_NUM_CLUSTERS + i + 8];
         if (rdo)
         {
             scAux.rdoList.push_back(rdo);
             rdoCounter++;
         }
         row = 3; // rdo w2
         rdo = stripClusters[row * EFTrackingTransient::MAX_NUM_CLUSTERS + i + 8];
         if (rdo)
         {
             scAux.rdoList.push_back(rdo);
             rdoCounter++;
         }
         row = 4; // rdo w3
         rdo = stripClusters[row * EFTrackingTransient::MAX_NUM_CLUSTERS + i + 8];
         if (rdo)
         {
             scAux.rdoList.push_back(rdo);
             rdoCounter++;
         }
         row = 5; // rdo w4
         rdo = stripClusters[row * EFTrackingTransient::MAX_NUM_CLUSTERS + i + 8];
         if (rdo)
         {
             scAux.rdoList.push_back(rdo);
             rdoCounter++;
         }
         row = 6; // local x
         scAux.localPosition.push_back(std::bit_cast<double>(stripClusters[row * EFTrackingTransient::MAX_NUM_CLUSTERS + i + 8]));
 
         ATH_MSG_DEBUG("Strip [" << std::dec << "] "<<row * EFTrackingTransient::MAX_NUM_CLUSTERS + i + 8 << " " << std::hex << stripClusters[row * EFTrackingTransient::MAX_NUM_CLUSTERS + i + 8]);
         row = 8; // local covariance xx
         scAux.localCovariance.push_back(std::bit_cast<double>(stripClusters[row * EFTrackingTransient::MAX_NUM_CLUSTERS + i + 8]));
         row = 9; // global x
         scAux.globalPosition.push_back(std::bit_cast<double>(stripClusters[row * EFTrackingTransient::MAX_NUM_CLUSTERS + i + 8]));
         row = 10; // global y
         scAux.globalPosition.push_back(std::bit_cast<double>(stripClusters[row * EFTrackingTransient::MAX_NUM_CLUSTERS + i + 8]));
         row = 11; // global z
         scAux.globalPosition.push_back(std::bit_cast<double>(stripClusters[row * EFTrackingTransient::MAX_NUM_CLUSTERS + i + 8]));
         row = 12; // channels in phi
         scAux.channelsInPhi.push_back(stripClusters[row * EFTrackingTransient::MAX_NUM_CLUSTERS + i + 8]);
 
         metadata->scRdoIndex[i] = rdoCounter;
     }
     // print out the strip cluster aux input
     if (msgLvl(MSG::DEBUG))
     {
         for (unsigned int i = 0; i < numStripClusters; i++)
         {
             ATH_MSG_DEBUG("Strip cluster " << i << " idHash: " << scAux.idHash[i]);
             ATH_MSG_DEBUG("Strip cluster " << i << std::hex << " id: " << scAux.id[i]);
             ATH_MSG_DEBUG("Strip cluster " << i << std::dec << " localPosition x: " << scAux.localPosition[i]);
             ATH_MSG_DEBUG("Strip cluster " << i << " localCovariance: " << scAux.localCovariance[i]);
             ATH_MSG_DEBUG("Strip cluster " << i << " globalPosition x: " << scAux.globalPosition[i * 3]);
             ATH_MSG_DEBUG("Strip cluster " << i << " globalPosition y: " << scAux.globalPosition[i * 3 + 1]);
             ATH_MSG_DEBUG("Strip cluster " << i << " globalPosition z: " << scAux.globalPosition[i * 3 + 2]);
             ATH_MSG_DEBUG("Strip cluster " << i << " channelsInPhi: " << scAux.channelsInPhi[i]);
             ATH_MSG_DEBUG("Strip cluster " << i << " rdoList size: " << metadata->scRdoIndex[i]);
         }
     }
 }
 
 
 
 
    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 ( ) const

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 FPGAStripClustering::initialize ( )

overridevirtual

Implementation of strip clustering using FPGA acceleration.

Reimplemented from IntegrationBase.

Definition at line 10 of file FPGAStripClustering.cxx.

                                           {
    ATH_CHECK(m_stripRDOKey.initialize());
    ATH_CHECK(m_FPGADataFormatTool.retrieve());
 
    ATH_CHECK(IntegrationBase::precheck({m_xclbin, m_kernelName, m_inputTV, m_refTV}));
    ATH_CHECK(IntegrationBase::initialize());
    ATH_CHECK(IntegrationBase::loadProgram(m_xclbin));
 
    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 ( ) const

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Reimplemented in InDet::GNNSeedingTrackMaker, InDet::SCT_Clusterization, InDet::SiSPGNNTrackMaker, InDet::SiSPSeededTrackFinder, InDet::SiTrackerSpacePointFinder, ITkPixelCablingAlg, ITkStripCablingAlg, RoIBResultToxAOD, SCT_ByteStreamErrorsTestAlg, SCT_CablingCondAlgFromCoraCool, SCT_CablingCondAlgFromText, SCT_ConditionsParameterTestAlg, SCT_ConditionsSummaryTestAlg, SCT_ConfigurationConditionsTestAlg, SCT_FlaggedConditionTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_PrepDataToxAOD, SCT_RawDataToxAOD, SCT_ReadCalibChipDataTestAlg, SCT_ReadCalibDataTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_SiliconConditionsTestAlg, SCT_StripVetoTestAlg, SCT_TdaqEnabledTestAlg, SCT_TestCablingAlg, SCTEventFlagWriter, SCTRawDataProvider, SCTSiLorentzAngleTestAlg, SCTSiPropertiesTestAlg, and Simulation::BeamEffectsAlg.

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

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

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

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 HypoBase, and InputMakerBase.

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.

{this, "bdfID", "", "BDF ID of the accelerator card"}; 

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.

{this, "doEmulation", false, "If software or hardware emulation is being used for debugging"}; 

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> FPGAStripClustering::m_FPGADataFormatTool {this, "FPGADataFormatTool", "FPGADataFormatTool", "tool to convert RDOs into FPGA data format"}

private

Definition at line 34 of file FPGAStripClustering.h.

{this, "FPGADataFormatTool", "FPGADataFormatTool", "tool to convert RDOs into FPGA data format"};

m_inputTV

Gaudi::Property<std::string> FPGAStripClustering::m_inputTV {this, "InputTV", "", "Input TestVector"}

private

Input TestVector.

Definition at line 29 of file FPGAStripClustering.h.

{this, "InputTV", "", "Input TestVector"};   

m_kernelName

Gaudi::Property<std::string> FPGAStripClustering::m_kernelName {this, "KernelName", "", "Kernel name"}

private

Kernel name.

Definition at line 28 of file FPGAStripClustering.h.

{this, "KernelName", "", "Kernel name"};  

m_program

cl::Program IntegrationBase::m_program

protectedinherited

Program object containing the kernel.

Definition at line 68 of file IntegrationBase.h.

m_refTV

Gaudi::Property<std::string> FPGAStripClustering::m_refTV {this, "RefTV", "", "Reference TestVector"}

private

Reference TestVector.

Definition at line 30 of file FPGAStripClustering.h.

{this, "RefTV", "", "Reference TestVector"};   

m_stripRDOKey

SG::ReadHandleKey<SCT_RDO_Container> FPGAStripClustering::m_stripRDOKey {this, "StripRDO", "ITkStripRDOs", "Input data for strip clustering"}

private

Input data key.

Definition at line 32 of file FPGAStripClustering.h.

{this, "StripRDO", "ITkStripRDOs", "Input data for strip clustering"}; 

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_xclbin

Gaudi::Property<std::string> FPGAStripClustering::m_xclbin {this, "xclbin", "", "xclbin path and name"}

private

Path and name of the xclbin file.

Definition at line 27 of file FPGAStripClustering.h.

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

---

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

• FPGAStripClustering.h
• FPGAStripClustering.cxx