ATLAS Offline Software
Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
EFTrackingXrtAlgorithm Class Reference

#include <EFTrackingXrtAlgorithm.h>

Inheritance diagram for EFTrackingXrtAlgorithm:
Collaboration diagram for EFTrackingXrtAlgorithm:

Public Member Functions

 EFTrackingXrtAlgorithm (const std::string &name, ISvcLocator *pSvcLocator)
 
StatusCode initialize () override final
 
StatusCode execute (const EventContext &ctx) const override final
 
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...
 

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

SG::ReadHandleKeyArray< std::vector< unsigned long > > m_inputDataStreamKeys {this, "inputDataStreamKeys", {}}
 Keys to access encoded 64bit words following the EFTracking specification. More...
 
SG::ReadHandleKeyArray< std::vector< unsigned long > > m_vSizeDataStreamKeys {this, "vSizeDataStreamKeys", {}}
 
SG::WriteHandleKeyArray< std::vector< unsigned long > > m_outputDataStreamKeys {this, "outputDataStreamKeys", {}}
 
ServiceHandle< AthXRT::IDeviceMgmtSvcm_DeviceMgmtSvc
 
ServiceHandle< IChronoSvc > m_chronoSvc
 
Gaudi::Property< std::vector< std::tuple< std::string, std::string, int > > > m_inputInterfaces
 
Gaudi::Property< std::vector< std::tuple< std::string, std::string, int > > > m_vSizeInterfaces
 
Gaudi::Property< std::vector< std::tuple< std::string, std::string, int > > > m_outputInterfaces
 
Gaudi::Property< std::size_t > m_bufferSize
 
std::map< std::string, std::unique_ptr< xrt::kernel > > m_kernels {}
 
std::map< std::string, std::unique_ptr< xrt::run > > m_runs {}
 
std::vector< xrt::bo > m_inputBuffers ATLAS_THREAD_SAFE {}
 
std::vector< xrt::bo > m_outputBuffers ATLAS_THREAD_SAFE {}
 
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

Generic Athena algorithm for running xclbin kernels, creating a mapping between store gate keys and kernel interfaces

Three interface types are supported, inputs, vSizes and outputs. Inputs and outputs are for memory mapped interfaces. VSizes tell the kernel how long an input is (based on the size() of the associated std::vector (retrieved from store gate).

Definition at line 35 of file EFTrackingXrtAlgorithm.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t
privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ EFTrackingXrtAlgorithm()

EFTrackingXrtAlgorithm::EFTrackingXrtAlgorithm ( const std::string &  name,
ISvcLocator *  pSvcLocator 
)

Definition at line 9 of file EFTrackingXrtAlgorithm.cxx.

12  : AthReentrantAlgorithm(name, pSvcLocator)
13 {}

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.

64 {
65  return 0;
66 }

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

172  {
173  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
174  hndl.value(),
175  hndl.documentation());
176 
177  }

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

158  {
159  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
160  hndl.value(),
161  hndl.documentation());
162 
163  }

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

186  {
187  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
188  hndl.value(),
189  hndl.documentation());
190  }

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

200  {
201  return PBASE::declareProperty(t);
202  }

◆ 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
nameName of the property.
hndlObject holding the property value.
docDocumentation 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.

249  {
250  this->declare(hndl.vhKey());
251  hndl.vhKey().setOwner(this);
252 
253  return PBASE::declareProperty(name,hndl,doc);
254  }

◆ 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
nameName of the property.
hndlObject holding the property value.
docDocumentation 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.

225  {
226  this->declare(hndl);
227  hndl.setOwner(this);
228 
229  return PBASE::declareProperty(name,hndl,doc);
230  }

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

263  {
264 
265  // std::ostringstream ost;
266  // ost << Algorithm::name() << " VHKA declareProp: " << name
267  // << " size: " << hndArr.keys().size()
268  // << " mode: " << hndArr.mode()
269  // << " vhka size: " << m_vhka.size()
270  // << "\n";
271  // debug() << ost.str() << endmsg;
272 
273  hndArr.setOwner(this);
274  m_vhka.push_back(&hndArr);
275 
276  Gaudi::Details::PropertyBase* p = PBASE::declareProperty(name, hndArr, doc);
277  if (p != 0) {
278  p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
279  } else {
280  ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray "
281  << name);
282  }
283 
284  return p;
285 
286  }

◆ 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
nameName of the property.
propertyObject holding the property value.
docDocumentation 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.

337  {
338  return PBASE::declareProperty(name, property, doc);
339  }

◆ 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
nameName of the property.
propertyObject holding the property value.
docDocumentation 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.

355  {
356  typedef typename SG::HandleClassifier<T>::type htype;
357  return declareProperty (name, property, doc, htype());
358  }

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

145  {
146  typedef typename SG::HandleClassifier<T>::type htype;
148  }

◆ 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 EFTrackingXrtAlgorithm::execute ( const EventContext &  ctx) const
finaloverride

Definition at line 112 of file EFTrackingXrtAlgorithm.cxx.

113 {
114  ATH_CHECK(m_inputDataStreamKeys.size() == m_inputBuffers.size());
115  std::size_t inputHandleIndex = 0;
116  for (
117  const SG::ReadHandleKey<std::vector<unsigned long>>& inputDataStreamKey :
119  ) {
121  ATH_MSG_DEBUG("Writing: " << inputDataStream.name());
122  unsigned long* inputMap = m_inputBuffers.at(inputHandleIndex).map<unsigned long*>();
123 
125 
126  ATH_MSG_DEBUG("Copy " + inputDataStream.name() + " from storegate to host side map");
127  {
128  Athena::Chrono chrono(
129  "Copy " + inputDataStream.name() + " from storegate to host side map",
130  m_chronoSvc.get()
131  );
132 
133  for (std::size_t index = 0; index < inputDataStream->size(); index++) {
134  inputMap[index] = inputDataStream->at(index);
135  }
136  }
137 
138  ATH_MSG_DEBUG("Copy " + inputDataStream.name() + " from host side map to device");
139  {
140  Athena::Chrono chrono(
141  "Copy " + inputDataStream.name() + " from host side map to device",
142  m_chronoSvc.get()
143  );
144 
145  m_inputBuffers.at(inputHandleIndex).sync(XCL_BO_SYNC_BO_TO_DEVICE);
146  }
147 
148  inputHandleIndex++;
149  }
150 
152  std::size_t vSizeHandleIndex = 0;
153  for (
154  const SG::ReadHandleKey<std::vector<unsigned long>>& vSizeDataStreamKey :
156  ) {
157  SG::ReadHandle<std::vector<unsigned long>> vSizeDataStream(vSizeDataStreamKey, ctx);
158  ATH_MSG_DEBUG("Setting VSize: " << vSizeDataStream.name());
159  const auto& [kernelName, storeGateKey, argumentIndex] = m_vSizeInterfaces[vSizeHandleIndex];
160 
161  m_runs.at(kernelName)->set_arg(argumentIndex, vSizeDataStream->size());
162  }
163 
164  ATH_MSG_DEBUG("Run kernels");
165  {
166  Athena::Chrono chrono("Run kernels", m_chronoSvc.get());
167 
168  for (const auto& [key, run] : m_runs) {
169  run->start();
170  }
171 
172  for (const auto& [key, run] : m_runs) {
173  run->wait();
174  }
175  }
176 
177  std::size_t outputHandleIndex = 0;
178  for (
179  const SG::WriteHandleKey<std::vector<unsigned long>>& outputDataStreamKey :
181  ) {
183  ATH_CHECK(outputDataStream.record(std::make_unique<std::vector<unsigned long>>(m_bufferSize)));
184 
185  ATH_MSG_DEBUG("Copy " + outputDataStream.name() + " from device to host side map");
186  {
187  Athena::Chrono chrono(
188  "Copy " + outputDataStream.name() + " from device to host side map",
189  m_chronoSvc.get()
190  );
191 
192  m_outputBuffers.at(outputHandleIndex).sync(XCL_BO_SYNC_BO_FROM_DEVICE);
193  }
194 
195  const unsigned long* outputMap = m_outputBuffers.at(outputHandleIndex).map<unsigned long*>();
196  ATH_MSG_DEBUG("Copy " + outputDataStream.name() + " from host side map to storegate");
197  {
198  Athena::Chrono chrono(
199  "Copy " + outputDataStream.name() + " from host side map to storegate",
200  m_chronoSvc.get()
201  );
202 
203  for (std::size_t index = 0; index < outputDataStream->size(); index++) {
204  outputDataStream->at(index) = outputMap[index];
205  }
206  }
207 
208  outputHandleIndex++;
209  }
210 
211  return StatusCode::SUCCESS;
212 }

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

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  }
96  return BaseAlg::extraOutputDeps();
97 }

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

◆ initialize()

StatusCode EFTrackingXrtAlgorithm::initialize ( )
finaloverride

Definition at line 15 of file EFTrackingXrtAlgorithm.cxx.

15  {
16  ATH_MSG_INFO("Initializing " << name());
17 
18  ATH_CHECK(m_DeviceMgmtSvc.retrieve());
19  ATH_CHECK(m_chronoSvc.retrieve());
20  ATH_CHECK(m_inputDataStreamKeys.initialize());
21  ATH_CHECK(m_vSizeDataStreamKeys.initialize());
22  ATH_CHECK(m_outputDataStreamKeys.initialize());
23 
24  for (const auto& [kernelName, storeGateKey, argumentIndex] : m_inputInterfaces) {
25  const std::vector<std::shared_ptr<xrt::device>> devices =
26  m_DeviceMgmtSvc->get_xrt_devices_by_kernel_name(kernelName);
27 
28  ATH_CHECK(devices.size() != 0);
29 
30  if (!m_kernels.contains(kernelName)) {
31  m_kernels[kernelName] = std::make_unique<xrt::kernel>(
32  *(devices[0]),
33  (devices[0])->get_xclbin_uuid(),
34  kernelName,
35  xrt::kernel::cu_access_mode::exclusive
36  );
37  }
38 
39  ATH_CHECK(m_kernels[kernelName].get() != nullptr);
40  m_inputBuffers.emplace_back(
41  *(devices[0]),
42  sizeof(unsigned long) * m_bufferSize,
43  xrt::bo::flags::normal,
44  m_kernels[kernelName]->group_id(argumentIndex)
45  );
46 
47  if (!m_runs.contains(kernelName)) {
48  m_runs[kernelName] = std::make_unique<xrt::run>(*m_kernels[kernelName]);
49  }
50 
51  ATH_CHECK(m_runs[kernelName].get() != nullptr);
52  m_runs[kernelName]->set_arg(argumentIndex, m_inputBuffers.back());
53  }
54 
55  for (const auto& [kernelName, storeGateKey, argumentIndex] : m_vSizeInterfaces) {
56  const std::vector<std::shared_ptr<xrt::device>> devices =
57  m_DeviceMgmtSvc->get_xrt_devices_by_kernel_name(kernelName);
58 
59  ATH_CHECK(devices.size() != 0);
60 
61  if (!m_kernels.contains(kernelName)) {
62  m_kernels[kernelName] = std::make_unique<xrt::kernel>(
63  *(devices[0]),
64  (devices[0])->get_xclbin_uuid(),
65  kernelName,
66  xrt::kernel::cu_access_mode::exclusive
67  );
68  }
69 
70  ATH_CHECK(m_kernels[kernelName].get() != nullptr);
71 
72  if (!m_runs.contains(kernelName)) {
73  m_runs[kernelName] = std::make_unique<xrt::run>(*m_kernels[kernelName]);
74  }
75 
76  ATH_CHECK(m_runs[kernelName].get() != nullptr);
77  }
78 
79  for (const auto& [kernelName, storeGateKey, argumentIndex] : m_outputInterfaces) {
80  const std::vector<std::shared_ptr<xrt::device>> devices =
81  m_DeviceMgmtSvc->get_xrt_devices_by_kernel_name(kernelName);
82 
83  ATH_CHECK(devices.size() != 0);
84 
85  if (!m_kernels.contains(kernelName)) {
86  m_kernels[kernelName] = std::make_unique<xrt::kernel>(
87  *(devices[0]),
88  devices[0]->get_xclbin_uuid(),
89  kernelName,
90  xrt::kernel::cu_access_mode::exclusive
91  );
92  }
93 
94  m_outputBuffers.emplace_back(
95  *(devices[0]),
96  sizeof(unsigned long) * m_bufferSize,
97  xrt::bo::flags::normal,
98  m_kernels[kernelName]->group_id(argumentIndex)
99  );
100 
101  if (!m_runs.contains(kernelName)) {
102  m_runs[kernelName] = std::make_unique<xrt::run>(*m_kernels[kernelName]);
103  }
104 
105  ATH_CHECK(m_runs[kernelName].get() != nullptr);
106  m_runs[kernelName]->set_arg(argumentIndex, m_outputBuffers.back());
107  }
108 
109  return StatusCode::SUCCESS;
110 }

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

52 {
53  // Reentrant algorithms are clonable.
54  return true;
55 }

◆ msg() [1/2]

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

Definition at line 24 of file AthCommonMsg.h.

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

◆ msg() [2/2]

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

Definition at line 27 of file AthCommonMsg.h.

27  {
28  return this->msgStream(lvl);
29  }

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

◆ 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();
383  PBASE::renounce (h);
384  }

◆ 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  {
365  handlesArray.renounce();
366  }

◆ setFilterPassed()

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

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

100  {
101  execState( ctx ).setFilterPassed( state );
102  }

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

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()) {
123  sc = StatusCode::FAILURE;
124  ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
125  << " with CondSvc");
126  }
127  }
128  }
129  return sc;
130 }

◆ 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) {
312  std::vector<SG::VarHandleKey*> keys = a->keys();
313  for (auto k : keys) {
314  k->setOwner(this);
315  }
316  }
317  }

Member Data Documentation

◆ ATLAS_THREAD_SAFE [1/2]

std::vector<xrt::bo> m_inputBuffers EFTrackingXrtAlgorithm::ATLAS_THREAD_SAFE {}
mutableprivate

Definition at line 90 of file EFTrackingXrtAlgorithm.h.

◆ ATLAS_THREAD_SAFE [2/2]

std::vector<xrt::bo> m_outputBuffers EFTrackingXrtAlgorithm::ATLAS_THREAD_SAFE {}
mutableprivate

Definition at line 91 of file EFTrackingXrtAlgorithm.h.

◆ m_bufferSize

Gaudi::Property<std::size_t> EFTrackingXrtAlgorithm::m_bufferSize
private
Initial value:
{
this,
"bufferSize",
8192,
"Capacity of xrt buffers in terms of 64bit words."
}

Definition at line 79 of file EFTrackingXrtAlgorithm.h.

◆ m_chronoSvc

ServiceHandle<IChronoSvc> EFTrackingXrtAlgorithm::m_chronoSvc
private
Initial value:
{
this,
"ChronoStatSvc",
"ChronoStatSvc",
"Stop watch"
}

Definition at line 51 of file EFTrackingXrtAlgorithm.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_DeviceMgmtSvc

ServiceHandle<AthXRT::IDeviceMgmtSvc> EFTrackingXrtAlgorithm::m_DeviceMgmtSvc
private
Initial value:
{
this,
"DeviceMgmtSvc",
"AthXRT::DeviceMgmtSvc",
"The XRT device manager service to use"
}

Definition at line 44 of file EFTrackingXrtAlgorithm.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_inputDataStreamKeys

SG::ReadHandleKeyArray<std::vector<unsigned long> > EFTrackingXrtAlgorithm::m_inputDataStreamKeys {this, "inputDataStreamKeys", {}}
private

Keys to access encoded 64bit words following the EFTracking specification.

Definition at line 40 of file EFTrackingXrtAlgorithm.h.

◆ m_inputInterfaces

Gaudi::Property<std::vector<std::tuple<std::string, std::string, int> > > EFTrackingXrtAlgorithm::m_inputInterfaces
private
Initial value:
{
this,
"inputInterfaces",
{},
""
}

Definition at line 58 of file EFTrackingXrtAlgorithm.h.

◆ m_kernels

std::map<std::string, std::unique_ptr<xrt::kernel> > EFTrackingXrtAlgorithm::m_kernels {}
private

Definition at line 86 of file EFTrackingXrtAlgorithm.h.

◆ m_outputDataStreamKeys

SG::WriteHandleKeyArray<std::vector<unsigned long> > EFTrackingXrtAlgorithm::m_outputDataStreamKeys {this, "outputDataStreamKeys", {}}
private

Definition at line 42 of file EFTrackingXrtAlgorithm.h.

◆ m_outputInterfaces

Gaudi::Property<std::vector<std::tuple<std::string, std::string, int> > > EFTrackingXrtAlgorithm::m_outputInterfaces
private
Initial value:
{
this,
"outputInterfaces",
{},
""
}

Definition at line 72 of file EFTrackingXrtAlgorithm.h.

◆ m_runs

std::map<std::string, std::unique_ptr<xrt::run> > EFTrackingXrtAlgorithm::m_runs {}
private

Definition at line 87 of file EFTrackingXrtAlgorithm.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_vSizeDataStreamKeys

SG::ReadHandleKeyArray<std::vector<unsigned long> > EFTrackingXrtAlgorithm::m_vSizeDataStreamKeys {this, "vSizeDataStreamKeys", {}}
private

Definition at line 41 of file EFTrackingXrtAlgorithm.h.

◆ m_vSizeInterfaces

Gaudi::Property<std::vector<std::tuple<std::string, std::string, int> > > EFTrackingXrtAlgorithm::m_vSizeInterfaces
private
Initial value:
{
this,
"vSizeInterfaces",
{},
""
}

Definition at line 65 of file EFTrackingXrtAlgorithm.h.


The documentation for this class was generated from the following files:
EFTrackingXrtAlgorithm::m_outputInterfaces
Gaudi::Property< std::vector< std::tuple< std::string, std::string, int > > > m_outputInterfaces
Definition: EFTrackingXrtAlgorithm.h:72
ATH_MSG_INFO
#define ATH_MSG_INFO(x)
Definition: AthMsgStreamMacros.h:31
PathfinderHlsConfig.inputDataStream
inputDataStream
Definition: PathfinderHlsConfig.py:66
make_unique
std::unique_ptr< T > make_unique(Args &&... args)
Definition: SkimmingToolEXOT5.cxx:23
SG::ReadHandle
Definition: StoreGate/StoreGate/ReadHandle.h:67
index
Definition: index.py:1
AthCommonDataStore::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 > renounce(T &h)
Definition: AthCommonDataStore.h:380
AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
Definition: AthCommonDataStore.h:390
AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka
std::vector< SG::VarHandleKeyArray * > m_vhka
Definition: AthCommonDataStore.h:398
read_hist_ntuple.t
t
Definition: read_hist_ntuple.py:5
SG::ReadHandleKey
Property holding a SG store/key/clid from which a ReadHandle is made.
Definition: StoreGate/StoreGate/ReadHandleKey.h:39
AthenaPoolTestRead.sc
sc
Definition: AthenaPoolTestRead.py:27
SG::VarHandleKeyArray::setOwner
virtual void setOwner(IDataHandleHolder *o)=0
AthReentrantAlgorithm
An algorithm that can be simultaneously executed in multiple threads.
Definition: AthReentrantAlgorithm.h:74
IDTPMcnv.htype
htype
Definition: IDTPMcnv.py:29
EFTrackingXrtAlgorithm::m_vSizeInterfaces
Gaudi::Property< std::vector< std::tuple< std::string, std::string, int > > > m_vSizeInterfaces
Definition: EFTrackingXrtAlgorithm.h:65
AthCommonDataStore::declareGaudiProperty
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition: AthCommonDataStore.h:156
AthCommonReentrantAlgorithm::extraOutputDeps
virtual const DataObjIDColl & extraOutputDeps() const override
Return the list of extra output dependencies.
Definition: AthCommonReentrantAlgorithm.cxx:89
python.utils.AtlRunQueryDQUtils.p
p
Definition: AtlRunQueryDQUtils.py:209
EFTrackingXrtAlgorithm::m_kernels
std::map< std::string, std::unique_ptr< xrt::kernel > > m_kernels
Definition: EFTrackingXrtAlgorithm.h:86
AthCommonDataStore
Definition: AthCommonDataStore.h:52
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
SG::WriteHandleKey
Property holding a SG store/key/clid from which a WriteHandle is made.
Definition: StoreGate/StoreGate/WriteHandleKey.h:40
Athena::Chrono
Exception-safe IChronoSvc caller.
Definition: Chrono.h:50
AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::outputHandles
virtual std::vector< Gaudi::DataHandle * > outputHandles() const override
Return this algorithm's output handles.
EL::StatusCode
::StatusCode StatusCode
StatusCode definition for legacy code.
Definition: PhysicsAnalysis/D3PDTools/EventLoop/EventLoop/StatusCode.h:22
ATH_MSG_DEBUG
#define ATH_MSG_DEBUG(x)
Definition: AthMsgStreamMacros.h:29
AthCommonDataStore::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T, V, H > &t)
Definition: AthCommonDataStore.h:145
AthCommonReentrantAlgorithm::sysExecute
virtual StatusCode sysExecute(const EventContext &ctx) override
Execute an algorithm.
Definition: AthCommonReentrantAlgorithm.cxx:76
ATH_CHECK
#define ATH_CHECK
Definition: AthCheckMacros.h:40
run
Definition: run.py:1
AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
Definition: AthCommonDataStore.h:393
EFTrackingXrtAlgorithm::m_inputDataStreamKeys
SG::ReadHandleKeyArray< std::vector< unsigned long > > m_inputDataStreamKeys
Keys to access encoded 64bit words following the EFTracking specification.
Definition: EFTrackingXrtAlgorithm.h:40
EFTrackingXrtAlgorithm::m_DeviceMgmtSvc
ServiceHandle< AthXRT::IDeviceMgmtSvc > m_DeviceMgmtSvc
Definition: EFTrackingXrtAlgorithm.h:44
EFTrackingXrtAlgorithm::m_inputInterfaces
Gaudi::Property< std::vector< std::tuple< std::string, std::string, int > > > m_inputInterfaces
Definition: EFTrackingXrtAlgorithm.h:58
SG::VarHandleKeyArray::renounce
virtual void renounce()=0
SG::HandleClassifier::type
std::conditional< std::is_base_of< SG::VarHandleKeyArray, T >::value, VarHandleKeyArrayType, type2 >::type type
Definition: HandleClassifier.h:54
merge_scale_histograms.doc
string doc
Definition: merge_scale_histograms.py:9
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:240
EFTrackingXrtAlgorithm::m_vSizeDataStreamKeys
SG::ReadHandleKeyArray< std::vector< unsigned long > > m_vSizeDataStreamKeys
Definition: EFTrackingXrtAlgorithm.h:41
SG::WriteHandle
Definition: StoreGate/StoreGate/WriteHandle.h:73
DeMoScan.index
string index
Definition: DeMoScan.py:362
a
TList * a
Definition: liststreamerinfos.cxx:10
h
ATH_MSG_WARNING
#define ATH_MSG_WARNING(x)
Definition: AthMsgStreamMacros.h:32
PathfinderHlsConfig.outputDataStream
outputDataStream
Definition: PathfinderHlsConfig.py:93
get
T * get(TKey *tobj)
get a TObject* from a TKey* (why can't a TObject be a TKey?)
Definition: hcg.cxx:127
SG::VarHandleBase::vhKey
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
Definition: StoreGate/src/VarHandleBase.cxx:629
AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysInitialize
virtual StatusCode sysInitialize() override
Override sysInitialize.
Definition: AthCommonReentrantAlgorithm.cxx:107
python.Bindings.keys
keys
Definition: Control/AthenaPython/python/Bindings.py:801
LHEF::Writer
Pythia8::Writer Writer
Definition: Prophecy4fMerger.cxx:12
EFTrackingXrtAlgorithm::m_bufferSize
Gaudi::Property< std::size_t > m_bufferSize
Definition: EFTrackingXrtAlgorithm.h:79
AthCommonReentrantAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects
DataObjIDColl m_extendedExtraObjects
Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
Definition: AthCommonReentrantAlgorithm.h:114
EFTrackingXrtAlgorithm::m_outputDataStreamKeys
SG::WriteHandleKeyArray< std::vector< unsigned long > > m_outputDataStreamKeys
Definition: EFTrackingXrtAlgorithm.h:42
EFTrackingXrtAlgorithm::m_runs
std::map< std::string, std::unique_ptr< xrt::run > > m_runs
Definition: EFTrackingXrtAlgorithm.h:87
fitman.k
k
Definition: fitman.py:528
ServiceHandle< ICondSvc >
mapkey::key
key
Definition: TElectronEfficiencyCorrectionTool.cxx:37
EFTrackingXrtAlgorithm::m_chronoSvc
ServiceHandle< IChronoSvc > m_chronoSvc
Definition: EFTrackingXrtAlgorithm.h:51