EFTrackingFPGAIntegration::F150KernelTesterAlg Class Reference

#include <F150KernelTesterAlg.h>

Inheritance diagram for EFTrackingFPGAIntegration::F150KernelTesterAlg:

Collaboration diagram for EFTrackingFPGAIntegration::F150KernelTesterAlg:

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	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
std::string	get_cu_name (const std::string &kernel_name, int cu)
void	dumpHexData (size_t dataLen, uint64_t *data, const std::string &dataDescriptor) const
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...
Gaudi::Property< std::string >	m_xclbin {this, "xclbin", "", "xclbin path and name"}
	Path and name of the xclbin file. More...
Gaudi::Property< bool >	m_runSE {this, "RunSlicing", "", "Whether to run slicing engine or not"}
	Whether to run SE or not. More...
Gaudi::Property< bool >	m_runIO {this, "RunInsideOut", "", "Whether to run inside out or not"}
	Whether to run inside out or not. More...
Gaudi::Property< bool >	m_runIOOnSE {this, "RunInsideOutOnSlicingEngine", "", "Whether to run inside out on the output of the slicing engine"}
	Whether to run inside out on the output of slicing engine. More...
SG::ReadHandleKey< FPGATrackSimHitCollection >	m_FPGAHitKey {this, "FPGATrackSimHitKey","FPGAHits", "FPGATrackSim hits key"}
SG::ReadHandleKey< FPGATrackSimHitCollection >	m_FPGASlicedHitKey {this, "FPGATrackSimHitKey_1st", "FPGAHits_1st_reg34", "FPGATrackSim Hits 1st stage key"}
SG::ReadHandleKey< FPGATrackSimTrackCollection >	m_FPGATrackKey {this, "FPGATrackSimTrack1stKey","FPGATracks_1st_reg34","FPGATrackSim Tracks 1st stage key"}
ToolHandle< OutputConversionTool >	m_outputConversionTool {this, "OutputConversionTool", "OutputConversionTool", "tool for output conversion"}
Gaudi::Property< std::string >	m_slicingEngineInputName {this, "SlicingEngineInputName", "", "Name of the slicing engine input kernel"}
Gaudi::Property< std::string >	m_slicingEngineName {this, "SlicingEngineName", "", "Name of the slicing engine kernel"}
Gaudi::Property< std::string >	m_slicingEngineOutputName {this, "SlicingEngineOutputName", "", "Name of the slicing engine output kernel"}
Gaudi::Property< std::string >	m_insideOutInputName {this, "InsideOutInputName", "", "Name of the inside out input kernel"}
Gaudi::Property< std::string >	m_insideOutOutputName {this, "InsideOutOutputName", "", "Name of the inside out output kernel"}
std::atomic< cl_ulong >	m_kernelTime {0}
	Time for kernel execution. More...
std::atomic< cl_ulong >	m_sum_kernelTime {0}
	Sum for the average time of the kernel execution. More...
std::atomic< ulonglong >	m_num_Events {0}
	Number of events for the average time of the kernel execution. More...
xrt::device	m_xrt_accelerator
cl::Event	m_slicingEngineInputEndEvent
cl::Event	m_slicingEngineOutputEndEvent
cl::Event	m_insideOutEndEvent
xrt::ip	m_slicingEngineIP
cl::Kernel	m_slicingEngineInput
cl::Kernel	m_slicingEngineOutput
cl::Kernel	m_insideOutInput
cl::Kernel	m_insideOutOutput
cl::Buffer	m_slicingEngineInputBuffer
cl::Buffer	m_slicingEngineOutputBuffer
cl::Buffer	m_insideOutInputBuffer
cl::Buffer	m_insideOutOutputBuffer
cl::CommandQueue	m_queue
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

Definition at line 39 of file F150KernelTesterAlg.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.

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.

{ return m_detStore; }

dumpHexData()

void EFTrackingFPGAIntegration::F150KernelTesterAlg::dumpHexData ( size_t  dataLen, uint64_t *  data, const std::string &  dataDescriptor  ) const

private

Definition at line 18 of file F150KernelTesterAlg.cxx.

                                                                                                               {
        ATH_MSG_DEBUG("STARTING " << dataDescriptor << " words:");
        for (size_t i = 0; i < dataLen; i++) {
          ATH_MSG_DEBUG(std::hex << std::setw(16) << std::setfill('0') << data[i]);
        }
        ATH_MSG_DEBUG("ENDING " << dataDescriptor << " words");
    }

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.

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

{ return m_evtStore; }

execute()

StatusCode EFTrackingFPGAIntegration::F150KernelTesterAlg::execute ( const EventContext &  ctx ) const

finaloverridevirtual

Should be overriden by derived classes to perform meaningful work.

Reimplemented from IntegrationBase.

Definition at line 81 of file F150KernelTesterAlg.cxx.

    {
        ATH_MSG_DEBUG("Executing F150KernelTesterAlg");
 
        cl_int err = CL_SUCCESS;
 
        int n_pixel_words = 4;
        size_t pixel_size_bytes = n_pixel_words * sizeof(uint64_t);
 
        if (m_runSE) {
          ATH_MSG_DEBUG("Allocating SE buffers");
          m_slicingEngineInputBuffer = cl::Buffer(m_context, CL_MEM_READ_ONLY, pixel_size_bytes, NULL, &err);
          m_slicingEngineOutputBuffer = cl::Buffer(m_context, CL_MEM_WRITE_ONLY, pixel_size_bytes, NULL, &err);
 
          ATH_MSG_DEBUG("Setting SE args");
          // TODO: FIX ARGS
          m_slicingEngineInput.setArg(0, m_slicingEngineInputBuffer); // Input buffer
          m_slicingEngineInput.setArg(1, n_pixel_words); // Input words
          m_slicingEngineOutput.setArg(0, m_slicingEngineOutputBuffer); // Output buffer
          m_slicingEngineOutput.setArg(1, n_pixel_words); // Output words (TODO: how do we get this???)
                                                          
          uint64_t out_data[n_pixel_words];
 
          // Write
          ATH_MSG_DEBUG("Loading input data to SE input kernel");
          // TODO: Replace with real data to write
          m_queue.enqueueWriteBuffer(m_slicingEngineInputBuffer, CL_TRUE, 0, pixel_size_bytes, &out_data);
          m_queue.finish();
          
          // Execute
          ATH_MSG_DEBUG("Executing SE kernel");
          m_slicingEngineIP.write_register(USER_CTRL_OFFSET, EVENT_COUNT_RST);
          m_queue.enqueueTask(m_slicingEngineInput);
          m_queue.enqueueTask(m_slicingEngineOutput);
          m_queue.finish();
 
          // Read
          ATH_MSG_DEBUG("Reading output data from kernel");
          m_queue.enqueueReadBuffer(m_slicingEngineOutputBuffer, CL_TRUE, 0, pixel_size_bytes, &out_data);
          m_queue.finish();
 
          dumpHexData(n_pixel_words, out_data, "Real Slicing Engine Output");
        }
        if (m_runIO) {
          ATH_MSG_DEBUG("Allocating IO buffers");
          if (!m_runIOOnSE) {
            m_insideOutInputBuffer = cl::Buffer(m_context, CL_MEM_READ_ONLY, pixel_size_bytes, NULL, &err);
          }
          m_insideOutOutputBuffer = cl::Buffer(m_context, CL_MEM_WRITE_ONLY, pixel_size_bytes, NULL, &err);
 
          ATH_MSG_DEBUG("Setting IO args");
          // TODO: FIX ARGS
          m_insideOutInput.setArg(0, m_runIOOnSE ? m_slicingEngineOutputBuffer : m_insideOutInputBuffer);
          m_insideOutOutput.setArg(0, m_insideOutOutputBuffer);
 
          uint64_t out_data[n_pixel_words];
 
          if (!m_runIOOnSE) {
            // Write
            ATH_MSG_DEBUG("Loading input data to IO input kernel");
            // TODO: Replace with real data to write
            m_queue.enqueueWriteBuffer(m_insideOutInputBuffer, CL_TRUE, 0, pixel_size_bytes, &out_data);
            m_queue.finish();
          }
 
          // Execute
          ATH_MSG_DEBUG("Executing IO kernel");
          m_queue.enqueueTask(m_insideOutInput);
          m_queue.enqueueTask(m_insideOutOutput);
          m_queue.finish();
 
          // Read
          ATH_MSG_DEBUG("Reading output data from kernel");
          m_queue.enqueueReadBuffer(m_slicingEngineOutputBuffer, CL_TRUE, 0, pixel_size_bytes, &out_data);
          m_queue.finish();
 
          dumpHexData(n_pixel_words, out_data, "Real Inside Out Output");
        }
 
 
        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::F150KernelTesterAlg::finalize ( )

finaloverridevirtual

Definition at line 164 of file F150KernelTesterAlg.cxx.

    {
      ATH_MSG_INFO("Average Kernel execution time: " << m_sum_kernelTime /m_num_Events /1e6 << " ms");
      return StatusCode::SUCCESS;
    }

get_cu_name()

std::string EFTrackingFPGAIntegration::F150KernelTesterAlg::get_cu_name ( const std::string &  kernel_name, int  cu  )

private

Definition at line 12 of file F150KernelTesterAlg.cxx.

                                                                                   {
        std::string full_cu_name = kernel_name + ":{" + kernel_name + "_" + std::to_string(cu) + "}";
        ATH_MSG_DEBUG("LOADING " + full_cu_name);
        return full_cu_name;
    }

initialize()

StatusCode EFTrackingFPGAIntegration::F150KernelTesterAlg::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 26 of file F150KernelTesterAlg.cxx.

    {
        ATH_MSG_INFO("Running on the FPGA accelerator");
        ATH_MSG_INFO("Testing Slicing Engine: " + m_runSE);
        ATH_MSG_INFO("Testing Inside Out: " + m_runIO);
        ATH_MSG_INFO("Testing Inside Out on Slicing Engine Output: " + m_runIOOnSE);
 
        ATH_CHECK(m_chronoSvc.retrieve());
 
        {
            Athena::Chrono chrono("Platform and device initialize", m_chronoSvc.get());
            ATH_CHECK(IntegrationBase::initialize());
        }
 
        {
            Athena::Chrono chrono("CL::loadProgram", m_chronoSvc.get());
            ATH_MSG_INFO("Loading Program: " + m_xclbin);
            ATH_CHECK(IntegrationBase::loadProgram(m_xclbin));
        }
 
        cl_int err = CL_SUCCESS;
 
        int cu = 1;
 
        if (m_runSE) {
          m_slicingEngineInput = cl::Kernel(m_program, get_cu_name(m_slicingEngineInputName, cu).c_str(), &err);
          m_slicingEngineOutput = cl::Kernel(m_program, get_cu_name(m_slicingEngineOutputName, cu).c_str(), &err);
 
          xrt::uuid loadedXclbinUUID = m_xrt_accelerator.get_xclbin_uuid();
          m_slicingEngineIP = xrt::ip(m_xrt_accelerator, loadedXclbinUUID, get_cu_name(m_slicingEngineName, cu).c_str());
        }
        if (m_runIO) {
          m_insideOutInput = cl::Kernel(m_program, get_cu_name(m_insideOutInputName, cu).c_str(), &err);
          m_insideOutOutput = cl::Kernel(m_program, get_cu_name(m_insideOutOutputName, cu).c_str(), &err);
        }
 
        m_queue = cl::CommandQueue(m_context, m_accelerator, CL_QUEUE_PROFILING_ENABLE | CL_QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE, &err);
        
        if (err != CL_SUCCESS) {
          return StatusCode::FAILURE;
        }
 
        ATH_CHECK(m_xaodClusterMaker.retrieve());
        ATH_CHECK(m_testVectorTool.retrieve());
        ATH_CHECK(m_FPGADataFormatTool.retrieve());
        ATH_CHECK(m_outputConversionTool.retrieve());
 
        // Initialize track sim keys
        ATH_CHECK(m_FPGAHitKey.initialize());
        ATH_CHECK(m_FPGASlicedHitKey.initialize());
        ATH_CHECK(m_FPGATrackKey.initialize());
 
        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();
  }

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::F150KernelTesterAlg::m_chronoSvc

private

Initial value:

{
            "ChronoStatSvc", name()}

Service for timing the algorithm.

Definition at line 49 of file F150KernelTesterAlg.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_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::F150KernelTesterAlg::m_FPGADataFormatTool

private

Initial value:

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

Tool for formatting FPGA data.

Definition at line 61 of file F150KernelTesterAlg.h.

m_FPGAHitKey

SG::ReadHandleKey<FPGATrackSimHitCollection> EFTrackingFPGAIntegration::F150KernelTesterAlg::m_FPGAHitKey {this, "FPGATrackSimHitKey","FPGAHits", "FPGATrackSim hits key"}

private

Definition at line 70 of file F150KernelTesterAlg.h.

m_FPGASlicedHitKey

SG::ReadHandleKey<FPGATrackSimHitCollection> EFTrackingFPGAIntegration::F150KernelTesterAlg::m_FPGASlicedHitKey {this, "FPGATrackSimHitKey_1st", "FPGAHits_1st_reg34", "FPGATrackSim Hits 1st stage key"}

private

Definition at line 71 of file F150KernelTesterAlg.h.

m_FPGATrackKey

SG::ReadHandleKey<FPGATrackSimTrackCollection> EFTrackingFPGAIntegration::F150KernelTesterAlg::m_FPGATrackKey {this, "FPGATrackSimTrack1stKey","FPGATracks_1st_reg34","FPGATrackSim Tracks 1st stage key"}

private

Definition at line 72 of file F150KernelTesterAlg.h.

m_insideOutEndEvent

cl::Event EFTrackingFPGAIntegration::F150KernelTesterAlg::m_insideOutEndEvent

private

Definition at line 92 of file F150KernelTesterAlg.h.

m_insideOutInput

cl::Kernel EFTrackingFPGAIntegration::F150KernelTesterAlg::m_insideOutInput

mutableprivate

Definition at line 99 of file F150KernelTesterAlg.h.

m_insideOutInputBuffer

cl::Buffer EFTrackingFPGAIntegration::F150KernelTesterAlg::m_insideOutInputBuffer

mutableprivate

Definition at line 106 of file F150KernelTesterAlg.h.

m_insideOutInputName

Gaudi::Property<std::string> EFTrackingFPGAIntegration::F150KernelTesterAlg::m_insideOutInputName {this, "InsideOutInputName", "", "Name of the inside out input kernel"}

private

Definition at line 81 of file F150KernelTesterAlg.h.

m_insideOutOutput

cl::Kernel EFTrackingFPGAIntegration::F150KernelTesterAlg::m_insideOutOutput

mutableprivate

Definition at line 100 of file F150KernelTesterAlg.h.

m_insideOutOutputBuffer

cl::Buffer EFTrackingFPGAIntegration::F150KernelTesterAlg::m_insideOutOutputBuffer

mutableprivate

Definition at line 107 of file F150KernelTesterAlg.h.

m_insideOutOutputName

Gaudi::Property<std::string> EFTrackingFPGAIntegration::F150KernelTesterAlg::m_insideOutOutputName {this, "InsideOutOutputName", "", "Name of the inside out output kernel"}

private

Definition at line 82 of file F150KernelTesterAlg.h.

m_kernelTime

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

mutableprivate

Time for kernel execution.

Definition at line 84 of file F150KernelTesterAlg.h.

m_num_Events

std::atomic<ulonglong> EFTrackingFPGAIntegration::F150KernelTesterAlg::m_num_Events {0}

mutableprivate

Number of events for the average time of the kernel execution.

Definition at line 86 of file F150KernelTesterAlg.h.

m_outputConversionTool

ToolHandle<OutputConversionTool> EFTrackingFPGAIntegration::F150KernelTesterAlg::m_outputConversionTool {this, "OutputConversionTool", "OutputConversionTool", "tool for output conversion"}

private

Definition at line 75 of file F150KernelTesterAlg.h.

m_program

cl::Program IntegrationBase::m_program

protectedinherited

Program object containing the kernel.

Definition at line 68 of file IntegrationBase.h.

m_queue

cl::CommandQueue EFTrackingFPGAIntegration::F150KernelTesterAlg::m_queue

private

Definition at line 110 of file F150KernelTesterAlg.h.

m_runIO

Gaudi::Property<bool> EFTrackingFPGAIntegration::F150KernelTesterAlg::m_runIO {this, "RunInsideOut", "", "Whether to run inside out or not"}

private

Whether to run inside out or not.

Definition at line 67 of file F150KernelTesterAlg.h.

m_runIOOnSE

Gaudi::Property<bool> EFTrackingFPGAIntegration::F150KernelTesterAlg::m_runIOOnSE {this, "RunInsideOutOnSlicingEngine", "", "Whether to run inside out on the output of the slicing engine"}

private

Whether to run inside out on the output of slicing engine.

Definition at line 68 of file F150KernelTesterAlg.h.

m_runSE

Gaudi::Property<bool> EFTrackingFPGAIntegration::F150KernelTesterAlg::m_runSE {this, "RunSlicing", "", "Whether to run slicing engine or not"}

private

Whether to run SE or not.

Definition at line 66 of file F150KernelTesterAlg.h.

m_slicingEngineInput

cl::Kernel EFTrackingFPGAIntegration::F150KernelTesterAlg::m_slicingEngineInput

mutableprivate

Definition at line 97 of file F150KernelTesterAlg.h.

m_slicingEngineInputBuffer

cl::Buffer EFTrackingFPGAIntegration::F150KernelTesterAlg::m_slicingEngineInputBuffer

mutableprivate

Definition at line 104 of file F150KernelTesterAlg.h.

m_slicingEngineInputEndEvent

cl::Event EFTrackingFPGAIntegration::F150KernelTesterAlg::m_slicingEngineInputEndEvent

private

Definition at line 90 of file F150KernelTesterAlg.h.

m_slicingEngineInputName

Gaudi::Property<std::string> EFTrackingFPGAIntegration::F150KernelTesterAlg::m_slicingEngineInputName {this, "SlicingEngineInputName", "", "Name of the slicing engine input kernel"}

private

Definition at line 78 of file F150KernelTesterAlg.h.

m_slicingEngineIP

xrt::ip EFTrackingFPGAIntegration::F150KernelTesterAlg::m_slicingEngineIP

mutableprivate

Definition at line 96 of file F150KernelTesterAlg.h.

m_slicingEngineName

Gaudi::Property<std::string> EFTrackingFPGAIntegration::F150KernelTesterAlg::m_slicingEngineName {this, "SlicingEngineName", "", "Name of the slicing engine kernel"}

private

Definition at line 79 of file F150KernelTesterAlg.h.

m_slicingEngineOutput

cl::Kernel EFTrackingFPGAIntegration::F150KernelTesterAlg::m_slicingEngineOutput

mutableprivate

Definition at line 98 of file F150KernelTesterAlg.h.

m_slicingEngineOutputBuffer

cl::Buffer EFTrackingFPGAIntegration::F150KernelTesterAlg::m_slicingEngineOutputBuffer

mutableprivate

Definition at line 105 of file F150KernelTesterAlg.h.

m_slicingEngineOutputEndEvent

cl::Event EFTrackingFPGAIntegration::F150KernelTesterAlg::m_slicingEngineOutputEndEvent

private

Definition at line 91 of file F150KernelTesterAlg.h.

m_slicingEngineOutputName

Gaudi::Property<std::string> EFTrackingFPGAIntegration::F150KernelTesterAlg::m_slicingEngineOutputName {this, "SlicingEngineOutputName", "", "Name of the slicing engine output kernel"}

private

Definition at line 80 of file F150KernelTesterAlg.h.

m_sum_kernelTime

std::atomic<cl_ulong> EFTrackingFPGAIntegration::F150KernelTesterAlg::m_sum_kernelTime {0}

mutableprivate

Sum for the average time of the kernel execution.

Definition at line 85 of file F150KernelTesterAlg.h.

m_testVectorTool

ToolHandle<TestVectorTool> EFTrackingFPGAIntegration::F150KernelTesterAlg::m_testVectorTool

private

Initial value:

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

Tool for preparing test vectors.

Definition at line 58 of file F150KernelTesterAlg.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::F150KernelTesterAlg::m_xaodClusterMaker

private

Initial value:

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

Tool for creating xAOD containers.

Definition at line 52 of file F150KernelTesterAlg.h.

m_xclbin

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

private

Path and name of the xclbin file.

Definition at line 64 of file F150KernelTesterAlg.h.

m_xrt_accelerator

xrt::device EFTrackingFPGAIntegration::F150KernelTesterAlg::m_xrt_accelerator

private

Definition at line 88 of file F150KernelTesterAlg.h.

---

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

• F150KernelTesterAlg.h
• F150KernelTesterAlg.cxx