cms::alpakatools::ScopedContextProduce< TQueue, typename > Class Template Reference

#include <ScopedContext.h>

Inheritance diagram for cms::alpakatools::ScopedContextProduce< TQueue, typename >:

Public Types
using	Event = alpaka::Event< Queue >
using	Queue = TQueue
using	ScopedContextGetterBase = impl::ScopedContextGetterBase< Queue >
Public Types inherited from cms::alpakatools::impl::ScopedContextGetterBase< TQueue >
using	Queue = TQueue
Public Types inherited from cms::alpakatools::impl::ScopedContextBase< TQueue >
using	Device = alpaka::Dev< Queue >
using	Platform = alpaka::Pltf< Device >
using	Queue = TQueue

Public Member Functions
template<typename T , typename... Args>
auto	emplace (edm::Event &iEvent, edm::EDPutTokenT< Product< Queue, T >> token, Args &&... args)
	ScopedContextProduce (ContextState< Queue > &state)
	Constructor to re-use the queue of acquire() (ExternalWork module) More...
	ScopedContextProduce (ProductBase< Queue > const &data)
	ScopedContextProduce (edm::StreamID streamID)
template<typename T >
std::unique_ptr< Product< Queue, T > >	wrap (T data)
	~ScopedContextProduce ()
	Record the event, all asynchronous work must have been queued before the destructor. More...
Public Member Functions inherited from cms::alpakatools::impl::ScopedContextGetterBase< TQueue >
const T &	get (Product< Queue, T > const &data)
const T &	get (edm::Event const &event, edm::EDGetTokenT< Product< Queue, T >> token)
Public Member Functions inherited from cms::alpakatools::impl::ScopedContextBase< TQueue >
Device	device () const
Queue &	queue ()
const std::shared_ptr< Queue > &	queuePtr () const

Private Member Functions
	ScopedContextProduce (std::shared_ptr< Queue > queue)

Private Attributes
std::shared_ptr< Event >	event_

Friends
class	::cms::alpakatest::TestScopedContext

Additional Inherited Members
Protected Member Functions inherited from cms::alpakatools::impl::ScopedContextGetterBase< TQueue >
	ScopedContextGetterBase (Args &&... args)
void	synchronizeStreams (ProductBase< Queue > const &data)
Protected Member Functions inherited from cms::alpakatools::impl::ScopedContextBase< TQueue >
	ScopedContextBase (ProductBase< Queue > const &data)
	ScopedContextBase (std::shared_ptr< Queue > queue)
	ScopedContextBase (edm::StreamID streamID)

Detailed Description

template<typename TQueue, typename>
class cms::alpakatools::ScopedContextProduce< TQueue, typename >

The aim of this class is to do necessary per-event "initialization" in ExternalWork produce() or normal produce():

• setting the current device
• synchronizing between queues if necessary and enforce that those get done in a proper way in RAII fashion.

Definition at line 201 of file ScopedContext.h.

Member Typedef Documentation

Event

template<typename TQueue , typename >

using cms::alpakatools::ScopedContextProduce< TQueue, typename >::Event = alpaka::Event<Queue>

Definition at line 204 of file ScopedContext.h.

Queue

template<typename TQueue , typename >

using cms::alpakatools::ScopedContextProduce< TQueue, typename >::Queue = TQueue

Definition at line 203 of file ScopedContext.h.

ScopedContextGetterBase

template<typename TQueue , typename >

using cms::alpakatools::ScopedContextProduce< TQueue, typename >::ScopedContextGetterBase = impl::ScopedContextGetterBase<Queue>

Definition at line 205 of file ScopedContext.h.

Constructor & Destructor Documentation

ScopedContextProduce() [1/4]

template<typename TQueue , typename >

cms::alpakatools::ScopedContextProduce< TQueue, typename >::ScopedContextProduce ( ContextState< Queue > &  state )

inlineexplicit

Constructor to re-use the queue of acquire() (ExternalWork module)

Definition at line 211 of file ScopedContext.h.

References cms::alpakatools::impl::ScopedContextBase< TQueue >::device().

        : ScopedContextGetterBase(state.releaseQueuePtr()), event_{getEventCache<Event>().get(device())} {}

ScopedContextProduce() [2/4]

template<typename TQueue , typename >

cms::alpakatools::ScopedContextProduce< TQueue, typename >::ScopedContextProduce ( ProductBase< Queue > const &  data )

inlineexplicit

Definition at line 214 of file ScopedContext.h.

References cms::alpakatools::impl::ScopedContextBase< TQueue >::device().

        : ScopedContextGetterBase(data), event_{getEventCache<Event>().get(device())} {}

ScopedContextProduce() [3/4]

template<typename TQueue , typename >

cms::alpakatools::ScopedContextProduce< TQueue, typename >::ScopedContextProduce ( edm::StreamID  streamID )

inlineexplicit

Definition at line 217 of file ScopedContext.h.

References cms::alpakatools::impl::ScopedContextBase< TQueue >::device().

        : ScopedContextGetterBase(streamID), event_{getEventCache<Event>().get(device())} {}

~ScopedContextProduce()

template<typename TQueue , typename >

cms::alpakatools::ScopedContextProduce< TQueue, typename >::~ScopedContextProduce ( )

inline

Record the event, all asynchronous work must have been queued before the destructor.

Definition at line 221 of file ScopedContext.h.

References cms::alpakatools::ScopedContextProduce< TQueue, typename >::event_, and cms::alpakatools::impl::ScopedContextBase< TQueue >::queue().

                            {
      // FIXME: this may throw an execption if the underlaying call fails.
      alpaka::enqueue(queue(), *event_);
    }

ScopedContextProduce() [4/4]

template<typename TQueue , typename >

cms::alpakatools::ScopedContextProduce< TQueue, typename >::ScopedContextProduce ( std::shared_ptr< Queue >  queue )

inlineexplicitprivate

Definition at line 240 of file ScopedContext.h.

References cms::alpakatools::impl::ScopedContextBase< TQueue >::device().

        : ScopedContextGetterBase(std::move(queue)), event_{getEventCache<Event>().get(device())} {}

Member Function Documentation

emplace()

template<typename TQueue , typename >

template<typename T , typename... Args>

auto cms::alpakatools::ScopedContextProduce< TQueue, typename >::emplace ( edm::Event &  iEvent, edm::EDPutTokenT< Product< Queue, T >>  token, Args &&...  args  )

inline

Definition at line 233 of file ScopedContext.h.

References writedatasetfile::args, cms::alpakatools::ScopedContextProduce< TQueue, typename >::event_, iEvent, cms::alpakatools::impl::ScopedContextBase< TQueue >::queuePtr(), and unpackBuffers-CaloStage2::token.

                                                                                            {
      return iEvent.emplace(token, queuePtr(), event_, std::forward<Args>(args)...);
    }

wrap()

template<typename TQueue , typename >

template<typename T >

std::unique_ptr<Product<Queue, T> > cms::alpakatools::ScopedContextProduce< TQueue, typename >::wrap ( T  data )

inline

Definition at line 227 of file ScopedContext.h.

References data, eostools::move(), and cms::alpakatools::impl::ScopedContextBase< TQueue >::queuePtr().

                                                  {
      // make_unique doesn't work because of private constructor
      return std::unique_ptr<Product<Queue, T>>(new Product<Queue, T>(queuePtr(), std::move(data)));
    }

Friends And Related Function Documentation

::cms::alpakatest::TestScopedContext

template<typename TQueue , typename >

friend class ::cms::alpakatest::TestScopedContext

friend

Definition at line 238 of file ScopedContext.h.

Member Data Documentation

event_

template<typename TQueue , typename >

std::shared_ptr<Event> cms::alpakatools::ScopedContextProduce< TQueue, typename >::event_

private

Definition at line 243 of file ScopedContext.h.

Referenced by cms::alpakatools::ScopedContextProduce< TQueue, typename >::emplace(), and cms::alpakatools::ScopedContextProduce< TQueue, typename >::~ScopedContextProduce().