ATLAS Offline Software
Loading...
Searching...
No Matches
Spacepoints Class Reference

#include <Spacepoints.h>

Inheritance diagram for Spacepoints:
Collaboration diagram for Spacepoints:

Public Member Functions

StatusCode initialize () override
 Detect the OpenCL devices and prepare OpenCL context.
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< StoreGateSvcStoreGateSvc_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.
ToolHandle< TestVectorToolm_testVectorTool {this, "TestVectorTool", "TestVectorTool", "Tool to prepare test vector"}
 Tool handle for TestVectorTool.
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

Definition at line 22 of file Spacepoints.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.

64{
65 return 0;
66}

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

158 {
160 hndl.value(),
161 hndl.documentation());
162
163 }
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T, V, H > &t)

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t)
inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

145 {
146 typedef typename SG::HandleClassifier<T>::type htype;
148 }
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>

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

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

◆ execute()

StatusCode Spacepoints::execute ( const EventContext & ctx) const
overridevirtual

Should be overriden by derived classes to perform meaningful work.

Reimplemented from IntegrationBase.

Definition at line 23 of file Spacepoints.cxx.

24{
25 ATH_MSG_DEBUG("In execute(), event slot: "<<ctx.slot());
26
27 int MAX_DATA_SIZE = 46219;
28
29 // Prepare input test vector
30 EFTrackingFPGAIntegration::TVHolder spacePointsTV("Spacepoints");
31 ATH_CHECK(m_testVectorTool->prepareTV(m_inputTV, spacePointsTV.inputTV));
32 ATH_CHECK(m_testVectorTool->prepareTV(m_refTV, spacePointsTV.refTV));
33
34 // print the first 10 elements of the input vector
35 for (int i = 0; i < 10; i++)
36 {
37 ATH_MSG_DEBUG("inputTV[" << std::dec << i << "] = " << std::hex << spacePointsTV.inputTV[i]<<std::dec);
38 }
39
40 // Work with the accelerator
41 cl_int err = 0;
42
43 // Allocate buffers on acc. card
44 cl::Buffer acc_inbuff(m_context, CL_MEM_READ_ONLY, spacePointsTV.inputTV.size() * sizeof(uint64_t), NULL, &err);
45 cl::Buffer acc_outbuff(m_context, CL_MEM_READ_WRITE, spacePointsTV.inputTV.size() * sizeof(uint64_t), NULL, &err);
46
47 // Prepare kernel
48 // Connect kernel to buffer before command queue
49 cl::Kernel acc_kernel(m_program, m_kernelName.value().data(), &err);
50 acc_kernel.setArg(0, acc_inbuff);
51 acc_kernel.setArg(1, acc_outbuff);
52 acc_kernel.setArg<int>(2, spacePointsTV.inputTV.size());
53
54 // Make queue of commands
55 cl::CommandQueue acc_queue(m_context, m_accelerator);
56
57 acc_queue.enqueueWriteBuffer(acc_inbuff, CL_TRUE, 0, spacePointsTV.inputTV.size() * sizeof(uint64_t), spacePointsTV.inputTV.data(), NULL, NULL);
58
59 // // Enqueue task
60 acc_queue.enqueueTask(acc_kernel);
61
62 acc_queue.finish();
63
64 std::vector<uint64_t> output(spacePointsTV.inputTV.size(), 0);
65
66 acc_queue.enqueueReadBuffer(acc_outbuff, CL_TRUE, 0, spacePointsTV.inputTV.size() * sizeof(uint64_t), output.data(), NULL, NULL);
67
68 // Compare the output with the reference
69 ATH_CHECK(m_testVectorTool->compare(spacePointsTV.refTV, output));
70
71 return StatusCode::SUCCESS;
72}
#define ATH_CHECK
Evaluate an expression and check for errors.
#define ATH_MSG_DEBUG(x)
cl::Program m_program
Program object containing the kernel.
cl::Context m_context
Context object for the application.
cl::Device m_accelerator
Device object for the accelerator card.
Gaudi::Property< std::string > m_kernelName
Kernel name.
Definition Spacepoints.h:31
Gaudi::Property< std::string > m_inputTV
Input TestVector.
Definition Spacepoints.h:32
ToolHandle< TestVectorTool > m_testVectorTool
Tool handle for TestVectorTool.
Definition Spacepoints.h:35
Gaudi::Property< std::string > m_refTV
Reference TestVector.
Definition Spacepoints.h:33
output
Definition merge.py:16

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

90{
91 // If we didn't find any symlinks to add, just return the collection
92 // from the base class. Otherwise, return the extended collection.
93 if (!m_extendedExtraObjects.empty()) {
95 }
97}
An algorithm that can be simultaneously executed in multiple threads.

◆ filterPassed()

virtual bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx) const
inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

96 {
97 return execState( ctx ).filterPassed();
98 }
virtual bool filterPassed(const EventContext &ctx) const

◆ initialize()

StatusCode Spacepoints::initialize ( )
overridevirtual

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 14 of file Spacepoints.cxx.

15{
19
20 return StatusCode::SUCCESS;
21}
StatusCode loadProgram(const std::string &xclbin)
Find the xclbin file and load it into the OpenCL program object.
virtual StatusCode initialize() override
Detect the OpenCL devices and prepare OpenCL context.
StatusCode precheck(const std::vector< Gaudi::Property< std::string > > &inputs) const
Check if the the desired Gaudi properties are set.
Gaudi::Property< std::string > m_xclbin
Path and name of the xclbin file.
Definition Spacepoints.h:30

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

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

116{
117 // Open binary object in binary mode
118 std::ifstream bin_file(xclbin, std::ios_base::binary);
119 if (!bin_file)
120 {
121 ATH_MSG_ERROR("Couldn't find the xclbin file: " << xclbin);
122 return StatusCode::FAILURE;
123 }
124 // Get the size of the binary file
125 bin_file.seekg(0, bin_file.end);
126 unsigned bin_size = bin_file.tellg();
127 // Reset the reference point back to the beginning
128 bin_file.seekg(0, bin_file.beg);
129 // Create a new pointer for the binary buffer and get the set a pointer to the binary buffer
130 std::vector<char> buf(bin_size);
131 bin_file.read(buf.data(), bin_size);
132
133 // Create binary object and program object
134 cl_int err = 0;
135 std::vector<cl_int> binaryStatus;
136 cl::Program::Binaries bins{{buf.data(), bin_size}};
137 m_program = cl::Program(m_context, {m_accelerator}, bins, &binaryStatus, &err);
138
139 bin_file.close();
140
141 if (err == CL_SUCCESS && binaryStatus.at(0) == CL_SUCCESS)
142 {
143 ATH_MSG_INFO("Successfully loaded xclbin file into " << m_accelerator.getInfo<CL_DEVICE_NAME>());
144 }
145 else
146 {
147 ATH_MSG_ERROR("Error loading xclbin file (" << xclbin << ") into " << m_accelerator.getInfo<CL_DEVICE_NAME>() <<". Error code: " << err);
148 return StatusCode::FAILURE;
149 }
150
151 return StatusCode::SUCCESS;
152}
#define ATH_MSG_ERROR(x)
#define ATH_MSG_INFO(x)
static const std::vector< std::string > bins

◆ msg()

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

Definition at line 24 of file AthCommonMsg.h.

24 {
25 return this->msgStream();
26 }

◆ msgLvl()

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

Definition at line 30 of file AthCommonMsg.h.

30 {
31 return this->msgLevel(lvl);
32 }

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

155{
156 for(const auto &item : inputs)
157 {
158 if(item.empty())
159 {
160 ATH_MSG_FATAL(item.documentation()<<" is empty. Please set it to a valid value");
161 return StatusCode::FAILURE;
162 }
163 }
164
165 // Always check if bdf is set
166 if (m_deviceBDF.empty())
167 {
168 ATH_MSG_WARNING("Device BDF is not set. Using the first found accelerator card. Set property 'bdfID' to specify the BDF of the device.");
169 }
170
171 return StatusCode::SUCCESS;
172}
#define ATH_MSG_FATAL(x)
#define ATH_MSG_WARNING(x)
Gaudi::Property< std::string > m_deviceBDF
BDF ID of the accelerator card.

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

381 {
382 h.renounce();
384 }
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)

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

364 {
366 }

◆ setFilterPassed()

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

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

100 {
102 }
virtual void setFilterPassed(bool state, const EventContext &ctx) const

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

77{
78 return BaseAlg::sysExecute (ctx);
79}

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

107 {
109
110 if (sc.isFailure()) {
111 return sc;
112 }
113
114 ServiceHandle<ICondSvc> cs("CondSvc",name());
115 for (auto h : outputHandles()) {
116 if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
117 // do this inside the loop so we don't create the CondSvc until needed
118 if ( cs.retrieve().isFailure() ) {
119 ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
120 return StatusCode::SUCCESS;
121 }
122 if (cs->regHandle(this,*h).isFailure()) {
124 ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
125 << " with CondSvc");
126 }
127 }
128 }
129 return sc;
130}
virtual std::vector< Gaudi::DataHandle * > outputHandles() const override

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

308 {
309 // debug() << "updateVHKA for property " << p.name() << " " << p.toString()
310 // << " size: " << m_vhka.size() << endmsg;
311 for (auto &a : m_vhka) {
313 for (auto k : keys) {
314 k->setOwner(this);
315 }
316 }
317 }

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.

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

70{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_inputTV

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

Input TestVector.

Definition at line 32 of file Spacepoints.h.

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

◆ m_kernelName

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

Kernel name.

Definition at line 31 of file Spacepoints.h.

31{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> Spacepoints::m_refTV {this, "RefTV", "", "Reference TestVector"}
private

Reference TestVector.

Definition at line 33 of file Spacepoints.h.

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

◆ m_testVectorTool

ToolHandle<TestVectorTool> Spacepoints::m_testVectorTool {this, "TestVectorTool", "TestVectorTool", "Tool to prepare test vector"}
private

Tool handle for TestVectorTool.

Definition at line 35 of file Spacepoints.h.

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

◆ 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> Spacepoints::m_xclbin {this, "xclbin", "", "xclbin path and name"}
private

Path and name of the xclbin file.

Definition at line 30 of file Spacepoints.h.

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

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