ALPAKA_ACCELERATOR_NAMESPACE::ESProducer Class Reference

#include <ESProducer.h>

Inheritance diagram for ALPAKA_ACCELERATOR_NAMESPACE::ESProducer:

Static Public Member Functions
static void	prevalidate (edm::ConfigurationDescriptions &descriptions)
Static Public Member Functions inherited from edm::eventsetup::DataProxyProvider
static void	prevalidate (ConfigurationDescriptions &)

Protected Member Functions
	ESProducer (edm::ParameterSet const &iConfig)
template<typename T >
auto	setWhatProduced (T *iThis, edm::es::Label const &label={})
template<typename T , typename TReturn , typename TRecord >
auto	setWhatProduced (T *iThis, TReturn(T ::*iMethod)(TRecord const &), edm::es::Label const &label={})
template<typename T , typename TReturn , typename TRecord >
auto	setWhatProduced (T *iThis, TReturn(T ::*iMethod)(device::Record< TRecord > const &), edm::es::Label const &label={})
Protected Member Functions inherited from edm::ESProducer
template<typename T >
auto	setWhatProduced (T *iThis, const es::Label &iLabel={})
template<typename T >
auto	setWhatProduced (T *iThis, const char *iLabel)
template<typename T >
auto	setWhatProduced (T *iThis, const std::string &iLabel)
template<typename T , typename TDecorator >
auto	setWhatProduced (T *iThis, const TDecorator &iDec, const es::Label &iLabel={})
template<typename T , typename TReturn , typename TRecord >
auto	setWhatProduced (T *iThis, TReturn(T ::*iMethod)(const TRecord &), const es::Label &iLabel={})
template<typename T , typename TReturn , typename TRecord , typename TArg >
auto	setWhatProduced (T *iThis, TReturn(T ::*iMethod)(const TRecord &), const TArg &iDec, const es::Label &iLabel={})
template<typename TFunc >
auto	setWhatProduced (TFunc &&func, const es::Label &iLabel={})
template<typename TReturn , typename TRecord , typename TFunc , typename TDecorator >
ESConsumesCollectorT< TRecord >	setWhatProduced (TFunc &&func, TDecorator &&iDec, const es::Label &iLabel={})
void	usesResources (std::vector< std::string > const &)
Protected Member Functions inherited from edm::ESProxyFactoryProducer
template<class TFactory >
void	registerFactory (std::unique_ptr< TFactory > iFactory, const std::string &iLabel=std::string())
virtual void	registerFactoryWithKey (const EventSetupRecordKey &iRecord, std::unique_ptr< eventsetup::ProxyFactoryBase > iFactory, const std::string &iLabel=std::string())
KeyedProxiesVector	registerProxies (const EventSetupRecordKey &, unsigned int iovIndex) override
Protected Member Functions inherited from edm::eventsetup::DataProxyProvider
template<class T >
void	usingRecord ()
void	usingRecordWithKey (const EventSetupRecordKey &key)

Private Types
using	Base = edm::ESProducer

Private Member Functions
template<typename TRecord , typename TFunc >
auto	setWhatProducedDevice (TFunc &&func, const edm::es::Label &label)

Static Private Member Functions
static void	throwSomeNullException ()

Private Attributes
std::string const	appendToDataLabel_
std::string const	moduleLabel_

Additional Inherited Members
Public Member Functions inherited from edm::ESProducer
	ESProducer ()
	ESProducer (const ESProducer &)=delete
ESProxyIndex const *	getTokenIndices (unsigned int iIndex) const
ESRecordIndex const *	getTokenRecordIndices (unsigned int iIndex) const
bool	hasMayConsumes () const noexcept
size_t	numberOfTokenIndices (unsigned int iIndex) const
ESProducer const &	operator= (const ESProducer &)=delete
SerialTaskQueueChain &	queue ()
template<typename Record >
std::optional< std::vector< ESProxyIndex > >	updateFromMayConsumes (unsigned int iIndex, const Record &iRecord) const
void	updateLookup (eventsetup::ESRecordsToProxyIndices const &) final
	~ESProducer () noexcept(false) override
Public Member Functions inherited from edm::ESProxyFactoryProducer
	ESProxyFactoryProducer ()
	ESProxyFactoryProducer (const ESProxyFactoryProducer &)=delete
const ESProxyFactoryProducer &	operator= (const ESProxyFactoryProducer &)=delete
	~ESProxyFactoryProducer () noexcept(false) override
Public Member Functions inherited from edm::eventsetup::DataProxyProvider
void	createKeyedProxies (EventSetupRecordKey const &key, unsigned int nConcurrentIOVs)
	DataProxyProvider ()
	DataProxyProvider (const DataProxyProvider &)=delete
const ComponentDescription &	description () const
void	fillRecordsNotAllowingConcurrentIOVs (std::set< EventSetupRecordKey > &recordsNotAllowingConcurrentIOVs) const
virtual void	initConcurrentIOVs (EventSetupRecordKey const &key, unsigned int nConcurrentIOVs)
bool	isUsingRecord (const EventSetupRecordKey &key) const
KeyedProxies &	keyedProxies (const EventSetupRecordKey &iRecordKey, unsigned int iovIndex=0)
const DataProxyProvider &	operator= (const DataProxyProvider &)=delete
void	setAppendToDataLabel (const edm::ParameterSet &)
void	setDescription (const ComponentDescription &iDescription)
std::set< EventSetupRecordKey >	usingRecords () const
virtual	~DataProxyProvider () noexcept(false)
Protected Types inherited from edm::ESProxyFactoryProducer
using	EventSetupRecordKey = eventsetup::EventSetupRecordKey
Protected Types inherited from edm::eventsetup::DataProxyProvider
using	KeyedProxiesVector = std::vector< std::pair< DataKey, std::shared_ptr< DataProxy > >>

Detailed Description

The ESProducer is a base class for modules producing data into the host memory space and/or the device memory space defined by the backend (i.e. ALPAKA_ACCELERATOR_NAMESPACE). The interface looks similar to the normal edm::ESProducer.

When producing a host product, the produce function should have the the usual Record argument. For producing a device product, the produce funtion should have device::Record<Record> argument.

Definition at line 26 of file ESProducer.h.

Member Typedef Documentation

Base

using ALPAKA_ACCELERATOR_NAMESPACE::ESProducer::Base = edm::ESProducer

private

Definition at line 27 of file ESProducer.h.

Constructor & Destructor Documentation

ESProducer()

ALPAKA_ACCELERATOR_NAMESPACE::ESProducer::ESProducer ( edm::ParameterSet const &  iConfig )

protected

Definition at line 5 of file ESProducer.cc.

      : moduleLabel_(iConfig.getParameter<std::string>("@module_label")),
        appendToDataLabel_(iConfig.getParameter<std::string>("appendToDataLabel")) {}

Member Function Documentation

prevalidate()

static void ALPAKA_ACCELERATOR_NAMESPACE::ESProducer::prevalidate ( edm::ConfigurationDescriptions &  descriptions )

inlinestatic

Definition at line 30 of file ESProducer.h.

References cms::alpakatools::module_backend_config(), and edm::eventsetup::DataProxyProvider::prevalidate().

                                                                        {
      Base::prevalidate(descriptions);
      cms::alpakatools::module_backend_config(descriptions);
    }

setWhatProduced() [1/3]

template<typename T >

auto ALPAKA_ACCELERATOR_NAMESPACE::ESProducer::setWhatProduced ( T *  iThis, edm::es::Label const &  label = {}  )

inlineprotected

Definition at line 39 of file ESProducer.h.

Referenced by ALPAKA_ACCELERATOR_NAMESPACE::TestAlpakaESProducerA::TestAlpakaESProducerA(), ALPAKA_ACCELERATOR_NAMESPACE::TestAlpakaESProducerB::TestAlpakaESProducerB(), ALPAKA_ACCELERATOR_NAMESPACE::TestAlpakaESProducerC::TestAlpakaESProducerC(), and ALPAKA_ACCELERATOR_NAMESPACE::TestAlpakaESProducerD::TestAlpakaESProducerD().

                                                             {}) {
      return setWhatProduced(iThis, &T::produce, label);
    }

setWhatProduced() [2/3]

template<typename T , typename TReturn , typename TRecord >

auto ALPAKA_ACCELERATOR_NAMESPACE::ESProducer::setWhatProduced ( T *  iThis, TReturn(T ::*)(TRecord const &)  iMethod, edm::es::Label const &  label = {}  )

inlineprotected

Definition at line 44 of file ESProducer.h.

                                                                                                   {}) {
      auto cc = Base::setWhatProduced(iThis, iMethod, label);
      using TProduct = typename edm::eventsetup::produce::smart_pointer_traits<TReturn>::type;
      if constexpr (not detail::useESProductDirectly<TProduct>) {
        // for device backends add the copy to device
        auto tokenPtr = std::make_shared<edm::ESGetToken<TProduct, TRecord>>();
        auto ccDev = setWhatProducedDevice<TRecord>(
            [tokenPtr](device::Record<TRecord> const& iRecord) {
              auto handle = iRecord.getTransientHandle(*tokenPtr);
              using CopyT = cms::alpakatools::CopyToDevice<TProduct>;
              return std::optional{CopyT::copyAsync(iRecord.queue(), *handle)};
            },
            label);
        *tokenPtr = ccDev.consumes(edm::ESInputTag{moduleLabel_, label.default_ + appendToDataLabel_});
      }
      return cc;
    }

setWhatProduced() [3/3]

template<typename T , typename TReturn , typename TRecord >

auto ALPAKA_ACCELERATOR_NAMESPACE::ESProducer::setWhatProduced ( T *  iThis, TReturn(T ::*)(device::Record< TRecord > const &)  iMethod, edm::es::Label const &  label = {}  )

inlineprotected

Definition at line 63 of file ESProducer.h.

                                                   {}) {
      using TProduct = typename edm::eventsetup::produce::smart_pointer_traits<TReturn>::type;
      if constexpr (detail::useESProductDirectly<TProduct>) {
        return Base::setWhatProduced(
            [iThis, iMethod](TRecord const& record) {
              auto const& devices = cms::alpakatools::devices<Platform>();
              assert(devices.size() == 1);
              device::Record<TRecord> const deviceRecord(record, devices.front());
              return std::invoke(iMethod, iThis, deviceRecord);
            },
            label);
      } else {
        return setWhatProducedDevice<TRecord>(
            [iThis, iMethod](device::Record<TRecord> const& record) { return std::invoke(iMethod, iThis, record); },
            label);
      }
    }

setWhatProducedDevice()

template<typename TRecord , typename TFunc >

auto ALPAKA_ACCELERATOR_NAMESPACE::ESProducer::setWhatProducedDevice ( TFunc &&  func, const edm::es::Label &  label  )

inlineprivate

Definition at line 85 of file ESProducer.h.

References cms::alpakatools::devices(), EcalMonitorTask_cff::func, label, eostools::move(), dumpMFGeometry_cfg::prod, ALPAKA_ACCELERATOR_NAMESPACE::device::Record< TRecord >::queuePtr(), AlCaHarvesting_cff::record, runTheMatrix::ret, edm::ESProducer::setWhatProduced(), throwSomeNullException(), and SequenceTypes::wait().

                                                                      {
      using Types = edm::eventsetup::impl::ReturnArgumentTypes<TFunc>;
      using TReturn = typename Types::return_type;
      using TProduct = typename edm::eventsetup::produce::smart_pointer_traits<TReturn>::type;
      using ProductType = ESDeviceProduct<TProduct>;
      using ReturnType = detail::ESDeviceProductWithStorage<TProduct, TReturn>;
      return Base::setWhatProduced(
          [function = std::forward<TFunc>(func)](TRecord const& record) -> std::unique_ptr<ProductType> {
            // TODO: move the multiple device support into EventSetup system itself
            auto const& devices = cms::alpakatools::devices<Platform>();
            std::vector<std::shared_ptr<Queue>> queues;
            queues.reserve(devices.size());
            auto ret = std::make_unique<ReturnType>(devices.size());
            bool allnull = true;
            bool anynull = false;
            for (auto const& dev : devices) {
              device::Record<TRecord> const deviceRecord(record, dev);
              auto prod = function(deviceRecord);
              if (prod) {
                allnull = false;
                ret->insert(dev, std::move(prod));
              } else {
                anynull = true;
              }
              queues.push_back(deviceRecord.queuePtr());
            }
            // TODO: to be changed asynchronous later
            for (auto& queuePtr : queues) {
              alpaka::wait(*queuePtr);
            }
            if (allnull) {
              return nullptr;
            } else if (anynull) {
              // TODO: throwing an exception if the iMethod() returns
              // null for some of th devices of one backend is
              // suboptimal. On the other hand, in the near term
              // multiple devices per backend is useful only for
              // private tests (not production), and the plan is to
              // make the EventSetup system itself aware of multiple
              // devies (or memory spaces). I hope this exception
              // would be good-enough until we get there.
              ESProducer::throwSomeNullException();
            }
            return ret;
          },
          label);
    }

throwSomeNullException()

void ALPAKA_ACCELERATOR_NAMESPACE::ESProducer::throwSomeNullException ( )

staticprivate

Definition at line 9 of file ESProducer.cc.

References Exception, and edm::errors::UnimplementedFeature.

Referenced by setWhatProducedDevice().

                                          {
    throw edm::Exception(edm::errors::UnimplementedFeature)
        << "The Alpaka backend has multiple devices. The device-specific produce() function returned a null product "
           "for some of the devices of the backend, but not all. This is not currently supported.";
  }

Member Data Documentation

appendToDataLabel_

std::string const ALPAKA_ACCELERATOR_NAMESPACE::ESProducer::appendToDataLabel_

private

Definition at line 136 of file ESProducer.h.

moduleLabel_

std::string const ALPAKA_ACCELERATOR_NAMESPACE::ESProducer::moduleLabel_

private

Definition at line 135 of file ESProducer.h.

Referenced by ExternalGeneratorFilter.ExternalGeneratorFilter::insertInto(), Modules.SwitchProducer::insertInto(), Mixins._TypedParameterizable::insertInto(), Modules.ESSource::nameInProcessDesc_(), and Modules.ESProducer::nameInProcessDesc_().