Example algorithm exercising the AthXRT core services. More...

#include <VectorMultOCLExampleAlg.h>

Inheritance diagram for AthExXRT::VectorMultOCLExampleAlg:

Collaboration diagram for AthExXRT::VectorMultOCLExampleAlg:

Classes
struct	SlotData
	Slot-specific state. More...

Public Member Functions
virtual StatusCode	initialize () override

virtual StatusCode	initialize_global () override
	Glocal XRT initialization. More...

virtual StatusCode	initialize_worker () override
	Initialization per process. More...

virtual StatusCode	execute (const EventContext &ctx) const override
	Function executing the algorithm. More...

virtual StatusCode	stop () override

virtual StatusCode	stop_worker () override
	clean up 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

void	handle (const Incident &incident) override

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
bool	m_is_child = false

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< AthXRT::IDeviceMgmtSvc >	m_DeviceMgmtSvc
	The XRT device manager to use. More...

std::vector< AthXRT::IDeviceMgmtSvc::OpenCLHandle >	m_handles

SG::SlotSpecificObj< SlotData >	m_slots
	List of slot-specific data. 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

Static Private Attributes
static constexpr char	s_krnl_name [] = "krnl_VectorMult"

static constexpr int	s_krnl_param_in1 = 0

static constexpr int	s_krnl_param_in2 = 1

static constexpr int	s_krnl_param_out = 2

static constexpr int	s_krnl_param_size = 3

static constexpr int	s_element_count = 4096

Detailed Description

Example algorithm exercising the AthXRT core services.

This example code is intended to demonstrate the integration of a classic hello world FPGA HLS kernel (Vector mltiplication) in Athena framework using the AthXRT device manager service prototype.

Author: Quentin Berthet quent.nosp@m.in.b.nosp@m.erthe.nosp@m.t@ce.nosp@m.rn.ch

Definition at line 29 of file VectorMultOCLExampleAlg.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 AthExXRT::VectorMultOCLExampleAlg::execute ( const EventContext & ctx ) const

overridevirtual

Function executing the algorithm.

Definition at line 130 of file VectorMultOCLExampleAlg.cxx.

                                                                          {
  
   // Get the slot (thread) specific data.
   const SlotData& slot = *m_slots.get(ctx);
  
   // Initialize the buffers with random data.
   for (std::size_t i = 0; i < s_element_count; ++i) {
     slot.m_host_buf_in1[i] = rand() % s_element_count;
     slot.m_host_buf_in2[i] = rand() % s_element_count;
   }
  
   ATH_MSG_DEBUG("Transfer data buffer to device");
   std::vector<cl::Memory> mems_vector = {*slot.m_dev_buf_in1,
                                          *slot.m_dev_buf_in2};
   ATH_CHECK(slot.m_queue->enqueueMigrateMemObjects(mems_vector, 0, nullptr,
                                                    nullptr) == CL_SUCCESS);
  
   // Schedule the kernel.
   ATH_MSG_DEBUG("Running kernel");
   ATH_CHECK(slot.m_queue->enqueueTask(*slot.m_kernel, nullptr, nullptr) ==
             CL_SUCCESS);
  
   // Migrate data back to host.
   ATH_MSG_DEBUG("Transfer data back to host");
   std::vector<cl::Memory> mems_out_vector = {*slot.m_dev_buf_out};
   ATH_CHECK(slot.m_queue->enqueueMigrateMemObjects(
                 mems_out_vector, CL_MIGRATE_MEM_OBJECT_HOST, nullptr,
                 nullptr) == CL_SUCCESS);
   ATH_CHECK(slot.m_queue->finish() == CL_SUCCESS);
  
   // Check that kernel results are correct.
   bool correct = true;
   for (std::size_t i = 0; i < s_element_count; ++i) {
     uint32_t cpu_result = slot.m_host_buf_in1[i] * slot.m_host_buf_in2[i];
     if (slot.m_host_buf_out[i] != cpu_result) {
       ATH_MSG_ERROR("Error: Result mismatch: i = "
                     << i << ": CPU result = " << cpu_result
                     << " Device result = " << slot.m_host_buf_out[i]);
       correct = false;
       break;
     }
   }
   if (correct) {
     ATH_MSG_INFO("OpenCL vector multiplication test PASSED!");
   } else {
     ATH_MSG_ERROR("OpenCL vector multiplication test FAILED!");
     return StatusCode::FAILURE;
   }
  
   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();
   }

◆ handle()

void AthXRT::StateHandler::handle ( const Incident & incident )

inlineoverrideinherited

Definition at line 85 of file StateHandler.h.

   {
     const bool is_multiprocess = (Gaudi::Concurrency::ConcurrencyFlags::numProcs() > 0);
     if (is_multiprocess && incident.type() == AthenaInterprocess::UpdateAfterFork::type())
       {
     m_is_child = true;
         if (!this->initialize_worker().isSuccess())
         {
           throw GaudiException("Failed to initialize the XRT setup!",
                                "StateHandler::handle",
                                StatusCode::FAILURE);
         }
       }
   }

◆ initialize()

virtual StatusCode AthExXRT::VectorMultOCLExampleAlg::initialize ( )

inlineoverridevirtual

Reimplemented from AthXRT::StateHandler.

Definition at line 34 of file VectorMultOCLExampleAlg.h.

                                            {
       return StateHandler::initialize();
   }

◆ initialize_global()

StatusCode AthExXRT::VectorMultOCLExampleAlg::initialize_global ( )

overridevirtual

Glocal XRT initialization.

Reimplemented from AthXRT::StateHandler.

Definition at line 10 of file VectorMultOCLExampleAlg.cxx.

                                                       {
  
   ATH_MSG_INFO("initialize_global()");
  
   ATH_CHECK(m_DeviceMgmtSvc.retrieve());
  
   // Retrieve the list of OpencCL Handle(s) providing the kernel.
   m_handles = m_DeviceMgmtSvc->get_opencl_handles_by_kernel_name(s_krnl_name);
  
   if (m_handles.empty()) {
     ATH_MSG_ERROR("No OpenCL context provides kernel '" << s_krnl_name << "'");
     return StatusCode::FAILURE;
   }
  
   return StatusCode::SUCCESS;
 }

◆ initialize_worker()

StatusCode AthExXRT::VectorMultOCLExampleAlg::initialize_worker ( )

overridevirtual

Initialization per process.

Reimplemented from AthXRT::StateHandler.

Definition at line 27 of file VectorMultOCLExampleAlg.cxx.

                                                       {
  
   ATH_MSG_INFO("initialize_worker()");
  
   cl_int err = CL_SUCCESS;
  
   // Allocate slot specific resources.
   std::size_t slotIdx = 0;
   for (SlotData& slot : m_slots) {
     ATH_MSG_DEBUG("Allocating resources for slot " << slotIdx);
  
     if (m_handles.size() > 1) {
       ATH_MSG_WARNING("More than one OpenCL context provides a '"
                       << s_krnl_name << "' kernel (" << m_handles.size()
                       << "), using the first one");
     }
     slot.m_context = m_handles[0].context;
     slot.m_program = m_handles[0].program;
  
     // Create kernel objects.
     slot.m_kernel =
         std::make_unique<cl::Kernel>(*slot.m_program, s_krnl_name, &err);
     if (err != 0) {
       ATH_MSG_ERROR(
           "Could not create OpenCL kernel '"
           << s_krnl_name
           << "', check that correct XCLBIN is programmed by AthXRT service");
       return StatusCode::FAILURE;
     }
  
     // Create command queue.
     slot.m_queue = std::make_unique<cl::CommandQueue>(
         *slot.m_context, slot.m_context->getInfo<CL_CONTEXT_DEVICES>()[0], 0,
         &err);
     ATH_CHECK(err == CL_SUCCESS);
  
     const std::size_t size_in_bytes = s_element_count * sizeof(uint32_t);
  
     // Create buffer objects.
     // This create aligned buffer object both on host and device.
     slot.m_dev_buf_in1 = std::make_unique<cl::Buffer>(
         *slot.m_context, CL_MEM_READ_ONLY | CL_MEM_ALLOC_HOST_PTR,
         size_in_bytes, nullptr, &err);
     ATH_CHECK(err == CL_SUCCESS);
  
     slot.m_dev_buf_in2 = std::make_unique<cl::Buffer>(
         *slot.m_context, CL_MEM_READ_ONLY | CL_MEM_ALLOC_HOST_PTR,
         size_in_bytes, nullptr, &err);
     ATH_CHECK(err == CL_SUCCESS);
  
     slot.m_dev_buf_out = std::make_unique<cl::Buffer>(
         *slot.m_context, CL_MEM_WRITE_ONLY | CL_MEM_ALLOC_HOST_PTR,
         size_in_bytes, nullptr, &err);
     ATH_CHECK(err == CL_SUCCESS);
  
     slot.m_host_buf_in1 = (uint32_t*)slot.m_queue->enqueueMapBuffer(
         *slot.m_dev_buf_in1, CL_TRUE, CL_MAP_WRITE, 0, size_in_bytes, nullptr,
         nullptr, &err);
     ATH_CHECK(err == CL_SUCCESS);
  
     slot.m_host_buf_in2 = (uint32_t*)slot.m_queue->enqueueMapBuffer(
         *slot.m_dev_buf_in2, CL_TRUE, CL_MAP_WRITE, 0, size_in_bytes, nullptr,
         nullptr, &err);
     ATH_CHECK(err == CL_SUCCESS);
  
     slot.m_host_buf_out = (uint32_t*)slot.m_queue->enqueueMapBuffer(
         *slot.m_dev_buf_out, CL_TRUE, CL_MAP_READ, 0, size_in_bytes, nullptr,
         nullptr, &err);
     ATH_CHECK(err == CL_SUCCESS);
  
     // Set kernel arguments.
     ATH_CHECK(slot.m_kernel->setArg(s_krnl_param_in1, *slot.m_dev_buf_in1) ==
               CL_SUCCESS);
     ATH_CHECK(slot.m_kernel->setArg(s_krnl_param_in2, *slot.m_dev_buf_in2) ==
               CL_SUCCESS);
     ATH_CHECK(slot.m_kernel->setArg(s_krnl_param_out, *slot.m_dev_buf_out) ==
               CL_SUCCESS);
     ATH_CHECK(slot.m_kernel->setArg(s_krnl_param_size, s_element_count) ==
               CL_SUCCESS);
  
     ++slotIdx;
   }
  
   return StatusCode::SUCCESS;
 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ isClonable()

bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::isClonable

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Definition at line 68 of file AthCommonReentrantAlgorithm.cxx.

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

◆ msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

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

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ setFilterPassed()

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

inlinevirtualinherited

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

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

◆ stop()

virtual StatusCode AthExXRT::VectorMultOCLExampleAlg::stop ( )

inlineoverridevirtual

Reimplemented from AthXRT::StateHandler.

Definition at line 44 of file VectorMultOCLExampleAlg.h.

                                      {
       return StateHandler::stop();
   }

◆ stop_worker()

StatusCode AthExXRT::VectorMultOCLExampleAlg::stop_worker ( )

overridevirtual

clean up

Reimplemented from AthXRT::StateHandler.

Definition at line 113 of file VectorMultOCLExampleAlg.cxx.

                                                 {
  
   ATH_MSG_INFO("stop_worker(): Cleaning OCL environment");
   // Unmap buffer objects.
   for (SlotData& slot : m_slots) {
     ATH_CHECK(slot.m_queue->enqueueUnmapMemObject(
                   *slot.m_dev_buf_in1, slot.m_host_buf_in1) == CL_SUCCESS);
     ATH_CHECK(slot.m_queue->enqueueUnmapMemObject(
                   *slot.m_dev_buf_in2, slot.m_host_buf_in2) == CL_SUCCESS);
     ATH_CHECK(slot.m_queue->enqueueUnmapMemObject(
                   *slot.m_dev_buf_out, slot.m_host_buf_out) == CL_SUCCESS);
     ATH_CHECK(slot.m_queue->finish() == CL_SUCCESS);
   }
  
   return StatusCode::SUCCESS;
 }

◆ sysExecute()

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

overridevirtualinherited

Execute an algorithm.

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

Definition at line 85 of file AthCommonReentrantAlgorithm.cxx.

 {
   return BaseAlg::sysExecute (ctx);
 }

◆ sysInitialize()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysInitialize

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.

Reimplemented in InputMakerBase, and HypoBase.

Definition at line 61 of file AthCommonReentrantAlgorithm.cxx.

                                                                {
   StatusCode sc=AthCommonDataStore<AthCommonMsg<BaseAlg>>::sysInitialize();
  
   if (sc.isFailure()) {
     return sc;
   }
   
   ServiceHandle<ICondSvc> cs("CondSvc",name());
   for (auto h : outputHandles()) {
     if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
       // do this inside the loop so we don't create the CondSvc until needed
       if ( cs.retrieve().isFailure() ) {
         ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
         return StatusCode::SUCCESS;
       }      
       if (cs->regHandle(this,*h).isFailure()) {
         sc = StatusCode::FAILURE;
         ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                       << " with CondSvc");
       }
     }
   }
   return sc;  
 }

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                                {
     // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
     //         << "  size: " << m_vhka.size() << endmsg;
     for (auto &a : m_vhka) {
       std::vector<SG::VarHandleKey*> keys = a->keys();
       for (auto k : keys) {
         k->setOwner(this);
       }
     }
   }

Member Data Documentation

◆ m_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_DeviceMgmtSvc

ServiceHandle<AthXRT::IDeviceMgmtSvc> AthExXRT::VectorMultOCLExampleAlg::m_DeviceMgmtSvc

private

Initial value:

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

The XRT device manager to use.

Definition at line 51 of file VectorMultOCLExampleAlg.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_handles

std::vector<AthXRT::IDeviceMgmtSvc::OpenCLHandle> AthExXRT::VectorMultOCLExampleAlg::m_handles

private

Definition at line 68 of file VectorMultOCLExampleAlg.h.

◆ m_is_child

bool AthXRT::StateHandler::m_is_child = false

protectedinherited

Definition at line 81 of file StateHandler.h.

◆ m_slots

SG::SlotSpecificObj<SlotData> AthExXRT::VectorMultOCLExampleAlg::m_slots

private

List of slot-specific data.

Definition at line 95 of file VectorMultOCLExampleAlg.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.

◆ s_element_count

constexpr int AthExXRT::VectorMultOCLExampleAlg::s_element_count = 4096

staticconstexprprivate

Definition at line 66 of file VectorMultOCLExampleAlg.h.

◆ s_krnl_name

constexpr char AthExXRT::VectorMultOCLExampleAlg::s_krnl_name[] = "krnl_VectorMult"

staticconstexprprivate

Definition at line 56 of file VectorMultOCLExampleAlg.h.

◆ s_krnl_param_in1

constexpr int AthExXRT::VectorMultOCLExampleAlg::s_krnl_param_in1 = 0

staticconstexprprivate

Definition at line 60 of file VectorMultOCLExampleAlg.h.

◆ s_krnl_param_in2

constexpr int AthExXRT::VectorMultOCLExampleAlg::s_krnl_param_in2 = 1

staticconstexprprivate

Definition at line 61 of file VectorMultOCLExampleAlg.h.

◆ s_krnl_param_out

constexpr int AthExXRT::VectorMultOCLExampleAlg::s_krnl_param_out = 2

staticconstexprprivate

Definition at line 62 of file VectorMultOCLExampleAlg.h.

◆ s_krnl_param_size

constexpr int AthExXRT::VectorMultOCLExampleAlg::s_krnl_param_size = 3

staticconstexprprivate

Definition at line 63 of file VectorMultOCLExampleAlg.h.

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

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

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

◆ handle()

◆ initialize()

◆ initialize_global()

◆ initialize_worker()

◆ inputHandles()

◆ isClonable()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setFilterPassed()

◆ stop()

◆ stop_worker()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_DeviceMgmtSvc

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_handles

◆ m_is_child

◆ m_slots

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ s_element_count

◆ s_krnl_name

◆ s_krnl_param_in1

◆ s_krnl_param_in2

◆ s_krnl_param_out

◆ s_krnl_param_size