EFTrackingXrtAlgorithm Class Reference

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

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

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
std::optional< xrt::bo::flags >	determine_mem_flags (const std::unique_ptr< xrt::kernel > &kernel, const std::size_t index) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadHandleKeyArray< std::vector< unsigned long > >	m_inputDataStreamKeys {this, "inputDataStreamKeys", {}}
	Keys to access encoded 64bit words following the EFTracking specification.
SG::ReadHandleKeyArray< std::vector< unsigned long > >	m_vSizeDataStreamKeys {this, "vSizeDataStreamKeys", {}}
SG::WriteHandleKeyArray< std::vector< unsigned long > >	m_outputDataStreamKeys {this, "outputDataStreamKeys", {}}
ServiceHandle< AthXRT::IDeviceMgmtSvc >	m_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::vector< std::tuple< std::string, int, std::string, int > > >	m_sharedInterfaces
Gaudi::Property< std::vector< std::vector< std::string > > >	m_kernelOrder
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.
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

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.

  : AthReentrantAlgorithm(name, pSvcLocator)
{}

Member Function Documentation

cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::cardinality ( ) const

overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Definition at line 75 of file AthCommonReentrantAlgorithm.cxx.

{
  return 0;
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

determine_mem_flags()

std::optional< xrt::bo::flags > EFTrackingXrtAlgorithm::determine_mem_flags ( const std::unique_ptr< xrt::kernel > & kernel, const std::size_t index ) const

private

Definition at line 362 of file EFTrackingXrtAlgorithm.cxx.

        {
  for (
    const xrt::xclbin::kernel& kernelMetaData : 
    kernel->get_xclbin().get_kernels()
  ) {
    if (kernel->get_name() != kernelMetaData.get_name()) {
      continue;
    }
 
    for (const xrt::xclbin::arg& arg : kernelMetaData.get_args()) {
      if (arg.get_index() != index) {
        continue;
      }
 
      if (arg.get_mems().size() == 0) {
        ATH_MSG_WARNING(
          "No mems associated with argument " << 
          index <<
          " of " <<
          kernel->get_name() <<
          ". Expect more warnings."
        );
 
        return std::nullopt;
      }
      
      if (arg.get_mems()[0].get_tag().find("HOST") != std::string::npos) {
        return xrt::bo::flags::host_only;
      }
 
      return xrt::bo::flags::normal;
    }
  }
 
  return std::nullopt;
}

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

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

finaloverride

Definition at line 255 of file EFTrackingXrtAlgorithm.cxx.

{
  ATH_CHECK(m_inputDataStreamKeys.size() == m_inputBuffers.size());
  std::size_t inputHandleIndex = 0;
  for (
    const SG::ReadHandleKey<std::vector<unsigned long>>& inputDataStreamKey : 
    m_inputDataStreamKeys
  ) {
    SG::ReadHandle<std::vector<unsigned long>> inputDataStream(inputDataStreamKey, ctx);
    ATH_MSG_DEBUG("Writing: " << inputDataStream.name());
    unsigned long* inputMap = m_inputBuffers.at(inputHandleIndex).map<unsigned long*>();
 
    ATH_CHECK(inputDataStream->size() <= m_bufferSize);
 
    ATH_MSG_DEBUG("Copy " + inputDataStream.name() + " from storegate to host side map");
    {
      Athena::Chrono chrono(
        "Copy " + inputDataStream.name() + " from storegate to host side map",
        m_chronoSvc.get()
      );
 
      for (std::size_t index = 0; index < inputDataStream->size(); index++) {
        inputMap[index] = inputDataStream->at(index);
      }
    }
    
    ATH_MSG_DEBUG("Copy " + inputDataStream.name() + " from host side map to device");
    {
      Athena::Chrono chrono(
        "Copy " + inputDataStream.name() + " from host side map to device",
        m_chronoSvc.get()
      );
 
      m_inputBuffers.at(inputHandleIndex).sync(XCL_BO_SYNC_BO_TO_DEVICE);
    }
 
    inputHandleIndex++;
  }
 
  ATH_CHECK(m_vSizeDataStreamKeys.size() == m_vSizeInterfaces.size());
  std::size_t vSizeHandleIndex = 0;
  for (
    const SG::ReadHandleKey<std::vector<unsigned long>>& vSizeDataStreamKey : 
    m_vSizeDataStreamKeys
  ) {
    SG::ReadHandle<std::vector<unsigned long>> vSizeDataStream(vSizeDataStreamKey, ctx);
    const auto& [kernelName, storeGateKey, argumentIndex] = m_vSizeInterfaces[vSizeHandleIndex];
    ATH_MSG_DEBUG("Setting VSize: " << kernelName << ", " << vSizeDataStream.name() << ", " << vSizeDataStream->size());
 
    m_runs.at(kernelName)->set_arg(argumentIndex, vSizeDataStream->size());
    vSizeHandleIndex++;
  }
 
  ATH_MSG_DEBUG("Run kernels");
  {
    Athena::Chrono chrono("Run kernels", m_chronoSvc.get());
 
    for (const auto& kernelNames : m_kernelOrder) {
      for (const auto& kernelName : kernelNames) {
        ATH_MSG_DEBUG("Running: " << kernelName);
        m_runs.at(kernelName)->start();
      }
 
      for (const auto& kernelName : kernelNames) {
        ATH_MSG_DEBUG("Waiting: " << kernelName);
        m_runs.at(kernelName)->wait();
      }
    }
  }
 
  std::size_t outputHandleIndex = 0;
  for (
    const SG::WriteHandleKey<std::vector<unsigned long>>& outputDataStreamKey : 
    m_outputDataStreamKeys
  ) {
    SG::WriteHandle<std::vector<unsigned long>> outputDataStream(outputDataStreamKey, ctx);
    ATH_CHECK(outputDataStream.record(std::make_unique<std::vector<unsigned long>>(m_bufferSize)));
 
    ATH_MSG_DEBUG("Copy " + outputDataStream.name() + " from device to host side map");
    {
      Athena::Chrono chrono(
        "Copy " + outputDataStream.name() + " from device to host side map",
        m_chronoSvc.get()
      );
 
      m_outputBuffers.at(outputHandleIndex).sync(XCL_BO_SYNC_BO_FROM_DEVICE);
    }
 
    const unsigned long* outputMap = m_outputBuffers.at(outputHandleIndex).map<unsigned long*>();
    ATH_MSG_DEBUG("Copy " + outputDataStream.name() + " from host side map to storegate");
    {
      Athena::Chrono chrono(
        "Copy " + outputDataStream.name() + " from host side map to storegate",
        m_chronoSvc.get()
      );
 
      for (std::size_t index = 0; index < outputDataStream->size(); index++) {
        outputDataStream->at(index) = outputMap[index];
      }
    }
 
    outputHandleIndex++;
  }
 
  return StatusCode::SUCCESS;
}

extraDeps_update_handler()

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

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

extraOutputDeps()

const DataObjIDColl & AthCommonReentrantAlgorithm< Gaudi::Algorithm >::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 94 of file AthCommonReentrantAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return BaseAlg::extraOutputDeps();
}

filterPassed()

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

inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

                                                           {
    return execState( ctx ).filterPassed();
  }

initialize()

StatusCode EFTrackingXrtAlgorithm::initialize ( )

finaloverride

Definition at line 15 of file EFTrackingXrtAlgorithm.cxx.

                                              {
  ATH_MSG_INFO("Initializing " << name());
 
  ATH_CHECK(m_DeviceMgmtSvc.retrieve());
  ATH_CHECK(m_chronoSvc.retrieve());
  ATH_CHECK(m_inputDataStreamKeys.initialize());
  ATH_CHECK(m_vSizeDataStreamKeys.initialize());
  ATH_CHECK(m_outputDataStreamKeys.initialize());
 
  for (const auto& [kernelName, storeGateKey, argumentIndex] : m_inputInterfaces) {
    ATH_MSG_DEBUG(
      "Setting up " << 
      kernelName << 
      " to read " << 
      storeGateKey << 
      " into argument " << 
      argumentIndex
    );
 
    const std::vector<std::shared_ptr<xrt::device>> devices = 
      m_DeviceMgmtSvc->get_xrt_devices_by_kernel_name(kernelName);
 
    ATH_CHECK(devices.size() != 0);
 
    if (!m_kernels.contains(kernelName)) {
      m_kernels[kernelName] = std::make_unique<xrt::kernel>(
        *(devices[0]),
        (devices[0])->get_xclbin_uuid(),
        kernelName,
        xrt::kernel::cu_access_mode::exclusive
      );
    }
 
    ATH_CHECK(m_kernels[kernelName].get() != nullptr);
 
    const std::optional<xrt::bo::flags> mem_flags = 
      determine_mem_flags(m_kernels[kernelName], argumentIndex);
 
    if (!mem_flags.has_value()) {
      ATH_MSG_WARNING(
          "Unable to determine mem_flags for argument with index " << 
          argumentIndex <<
          " in kernel named " <<
          kernelName << 
          ". Defaulting to xrt::bo::normal. Good luck!"
      );
 
      m_inputBuffers.emplace_back(
        *(devices[0]), 
        sizeof(unsigned long) * m_bufferSize, 
        xrt::bo::flags::normal, 
        m_kernels[kernelName]->group_id(argumentIndex)
      );
    }
    else {
      m_inputBuffers.emplace_back(
        *(devices[0]), 
        sizeof(unsigned long) * m_bufferSize, 
        mem_flags.value(), 
        m_kernels[kernelName]->group_id(argumentIndex)
      );
    }
 
    if (!m_runs.contains(kernelName)) {
      m_runs[kernelName] = std::make_unique<xrt::run>(*m_kernels[kernelName]);
    }
 
    ATH_CHECK(m_runs[kernelName].get() != nullptr);
    m_runs[kernelName]->set_arg(argumentIndex, m_inputBuffers.back());
  }
 
  for (const auto& [kernelName, storeGateKey, argumentIndex] : m_vSizeInterfaces) {
    ATH_MSG_DEBUG(
      "Setting up " << 
      kernelName << 
      " to get input size from " << 
      storeGateKey << 
      " for argument " << 
      argumentIndex
    );
 
    const std::vector<std::shared_ptr<xrt::device>> devices = 
      m_DeviceMgmtSvc->get_xrt_devices_by_kernel_name(kernelName);
 
    ATH_CHECK(devices.size() != 0);
 
    if (!m_kernels.contains(kernelName)) {
      m_kernels[kernelName] = std::make_unique<xrt::kernel>(
        *(devices[0]),
        (devices[0])->get_xclbin_uuid(),
        kernelName,
        xrt::kernel::cu_access_mode::exclusive
      );
    }
 
    ATH_CHECK(m_kernels[kernelName].get() != nullptr);
 
    if (!m_runs.contains(kernelName)) {
      m_runs[kernelName] = std::make_unique<xrt::run>(*m_kernels[kernelName]);
    }
 
    ATH_CHECK(m_runs[kernelName].get() != nullptr);
  }
 
  for (const auto& [kernelName, storeGateKey, argumentIndex] : m_outputInterfaces) {
    ATH_MSG_DEBUG(
      "Setting up " << 
      kernelName << 
      " to write " << 
      storeGateKey << 
      " from argument " << 
      argumentIndex
    );
 
    const std::vector<std::shared_ptr<xrt::device>> devices = 
      m_DeviceMgmtSvc->get_xrt_devices_by_kernel_name(kernelName);
 
    ATH_CHECK(devices.size() != 0);
 
    if (!m_kernels.contains(kernelName)) {
      m_kernels[kernelName] = std::make_unique<xrt::kernel>(
        *(devices[0]),
        devices[0]->get_xclbin_uuid(),
        kernelName,
        xrt::kernel::cu_access_mode::exclusive
      );
    }
 
    const std::optional<xrt::bo::flags> mem_flags = 
      determine_mem_flags(m_kernels[kernelName], argumentIndex);
 
    if (!mem_flags.has_value()) {
      ATH_MSG_WARNING(
          "Unable to determine mem_flags for argument with index " << 
          argumentIndex <<
          " in kernel named " <<
          kernelName << 
          ". Defaulting to xrt::bo::normal. Good luck!"
      );
 
      m_outputBuffers.emplace_back(
        *(devices[0]), 
        sizeof(unsigned long) * m_bufferSize, 
        xrt::bo::flags::normal, 
        m_kernels[kernelName]->group_id(argumentIndex)
      );
    }
    else {
      m_outputBuffers.emplace_back(
        *(devices[0]), 
        sizeof(unsigned long) * m_bufferSize, 
        mem_flags.value(), 
        m_kernels[kernelName]->group_id(argumentIndex)
      );
    }
 
    if (!m_runs.contains(kernelName)) {
      m_runs[kernelName] = std::make_unique<xrt::run>(*m_kernels[kernelName]);
    }
 
    ATH_CHECK(m_runs[kernelName].get() != nullptr);
    m_runs[kernelName]->set_arg(argumentIndex, m_outputBuffers.back());
  }
 
  for (const auto& [kernelName, argumentIndex, sourceKernelName, sourceArgumentIndex] : m_sharedInterfaces) {
    ATH_MSG_DEBUG(
      "Setting up shared buffer between " << 
      kernelName << 
      " argument " << 
      argumentIndex << 
      " and " << 
      sourceKernelName <<
      " argument " <<
      sourceArgumentIndex
    );
 
    const std::vector<std::shared_ptr<xrt::device>> devices = 
      m_DeviceMgmtSvc->get_xrt_devices_by_kernel_name(kernelName);
 
    ATH_CHECK(devices.size() != 0);
 
    if (!m_kernels.contains(kernelName)) {
      m_kernels[kernelName] = std::make_unique<xrt::kernel>(
        *(devices[0]),
        devices[0]->get_xclbin_uuid(),
        kernelName,
        xrt::kernel::cu_access_mode::exclusive
      );
    }
 
    if (!m_runs.contains(kernelName)) {
      m_runs[kernelName] = std::make_unique<xrt::run>(*m_kernels[kernelName]);
    }
 
    ATH_CHECK(m_runs[kernelName].get() != nullptr);
 
    std::size_t index = 0;
    for (const auto& [outputKernelName, outputStoreGateKey, outputArgumentIndex] : m_outputInterfaces) {
      if (
        outputKernelName == sourceKernelName &&
        outputArgumentIndex == sourceArgumentIndex
      ) {
        m_runs[kernelName]->set_arg(argumentIndex, m_outputBuffers[index]);
 
        break;
      }
 
      index++;
    }
  }
 
  for (const auto& kernelNames : m_kernelOrder) {
    for (const auto& kernelName : kernelNames) {
      const std::vector<std::shared_ptr<xrt::device>> devices = 
        m_DeviceMgmtSvc->get_xrt_devices_by_kernel_name(kernelName);
 
      ATH_CHECK(devices.size() != 0);
 
      if (!m_kernels.contains(kernelName)) {
        ATH_MSG_DEBUG("Creating kernel: " << kernelName);
 
        m_kernels[kernelName] = std::make_unique<xrt::kernel>(
          *(devices[0]),
          devices[0]->get_xclbin_uuid(),
          kernelName,
          xrt::kernel::cu_access_mode::exclusive
        );
 
        if (!m_runs.contains(kernelName)) {
          m_runs[kernelName] = std::make_unique<xrt::run>(*m_kernels[kernelName]);
        }
 
        ATH_CHECK(m_runs[kernelName].get() != nullptr);
      }
    }
  }
 
  return StatusCode::SUCCESS;
}

inputHandles()

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

overridevirtualinherited

Return this algorithm's input handles.

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

isClonable()

bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::isClonable ( ) const

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

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

Definition at line 68 of file AthCommonReentrantAlgorithm.cxx.

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

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

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

overridevirtualinherited

Return this algorithm's output handles.

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

renounce()

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

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

setFilterPassed()

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

inlinevirtualinherited

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

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

sysExecute()

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

overridevirtualinherited

Execute an algorithm.

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

Definition at line 85 of file AthCommonReentrantAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

sysInitialize()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

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

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

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

Reimplemented in HypoBase, and InputMakerBase.

Definition at line 61 of file AthCommonReentrantAlgorithm.cxx.

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

sysStart()

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

overridevirtualinherited

Handle START transition.

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

updateVHKA()

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

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

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

Member Data Documentation

ATLAS_THREAD_SAFE [1/2]

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

mutableprivate

Definition at line 104 of file EFTrackingXrtAlgorithm.h.

{};

ATLAS_THREAD_SAFE [2/2]

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

mutableprivate

Definition at line 105 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 93 of file EFTrackingXrtAlgorithm.h.

                                        {
    this,
    "bufferSize",
    8192,
    "Capacity of xrt buffers in terms of 64bit words."
  };

m_chronoSvc

ServiceHandle<IChronoSvc> EFTrackingXrtAlgorithm::m_chronoSvc

private

Initial value:

{
    this,
    "ChronoStatSvc",
    "ChronoStatSvc",
    "Stop watch"
  }

Definition at line 51 of file EFTrackingXrtAlgorithm.h.

                                       {
    this,
    "ChronoStatSvc",
    "ChronoStatSvc",
    "Stop watch"
  };

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.

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

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.

{this, "inputDataStreamKeys", {}};

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.

                                                                                  {
    this,
    "inputInterfaces",
    {},
    ""
  };

m_kernelOrder

Gaudi::Property<std::vector<std::vector<std::string> > > EFTrackingXrtAlgorithm::m_kernelOrder

private

Initial value:

{
    this,
    "kernelOrder",
    {},
    ""
  }

Definition at line 86 of file EFTrackingXrtAlgorithm.h.

                                                               {
    this,
    "kernelOrder",
    {},
    ""
  };

m_kernels

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

private

Definition at line 100 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.

{this, "outputDataStreamKeys", {}};

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.

                                                                                   {
    this,
    "outputInterfaces",
    {},
    ""
  };

m_runs

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

private

Definition at line 101 of file EFTrackingXrtAlgorithm.h.

{};

m_sharedInterfaces

Gaudi::Property<std::vector<std::tuple<std::string, int, std::string, int> > > EFTrackingXrtAlgorithm::m_sharedInterfaces

private

Initial value:

{
    this,
    "sharedInterfaces",
    {},
    ""
  }

Definition at line 79 of file EFTrackingXrtAlgorithm.h.

                                                                                        {
    this,
    "sharedInterfaces",
    {},
    ""
  };

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.

{this, "vSizeDataStreamKeys", {}};

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.

                                                                                  {
    this,
    "vSizeInterfaces",
    {},
    ""
  };

---

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

• EFTrackingXrtAlgorithm.h
• EFTrackingXrtAlgorithm.cxx