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

#include <ScopedContext.h>

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

Public Types
using	Queue = TQueue
using	ScopedContextBase = impl::ScopedContextBase< Queue >
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 F >
void	pushNextTask (F &&f)
Queue &	queue ()
const std::shared_ptr< Queue > &	queuePtr () const
void	replaceWaitingTaskHolder (edm::WaitingTaskWithArenaHolder waitingTaskHolder)
	ScopedContextTask (ContextState< Queue > const *state, edm::WaitingTaskWithArenaHolder waitingTaskHolder)
	Constructor to re-use the queue of acquire() (ExternalWork module) More...
	~ScopedContextTask ()
Public Member Functions inherited from cms::alpakatools::impl::ScopedContextBase< TQueue >
Device	device () const
Queue &	queue ()
const std::shared_ptr< Queue > &	queuePtr () const

Private Attributes
ContextState< Queue > const *	contextState_
impl::ScopedContextHolderHelper	holderHelper_

Additional Inherited Members
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::ScopedContextTask< TQueue, typename >

The aim of this class is to do necessary per-task "initialization" tasks created in ExternalWork acquire():

• setting the current device
• calling edm::WaitingTaskWithArenaHolder::doneWaiting() when necessary and enforce that those get done in a proper way in RAII fashion.

Definition at line 251 of file ScopedContext.h.

Member Typedef Documentation

Queue

template<typename TQueue , typename >

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

Definition at line 253 of file ScopedContext.h.

ScopedContextBase

template<typename TQueue , typename >

using cms::alpakatools::ScopedContextTask< TQueue, typename >::ScopedContextBase = impl::ScopedContextBase<Queue>

Definition at line 254 of file ScopedContext.h.

Constructor & Destructor Documentation

ScopedContextTask()

template<typename TQueue , typename >

cms::alpakatools::ScopedContextTask< TQueue, typename >::ScopedContextTask ( ContextState< Queue > const *  state, edm::WaitingTaskWithArenaHolder  waitingTaskHolder  )

inlineexplicit

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

Definition at line 259 of file ScopedContext.h.

References eostools::move().

        : ScopedContextBase(state->queuePtr()),  // don't move, state is re-used afterwards
          holderHelper_{std::move(waitingTaskHolder)},
          contextState_{state} {}

~ScopedContextTask()

template<typename TQueue , typename >

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

inline

Definition at line 264 of file ScopedContext.h.

References cms::alpakatools::impl::ScopedContextHolderHelper::enqueueCallback(), cms::alpakatools::ScopedContextTask< TQueue, typename >::holderHelper_, and cms::alpakatools::impl::ScopedContextBase< TQueue >::queue().

{ holderHelper_.enqueueCallback(queue()); }

Member Function Documentation

pushNextTask()

template<typename TQueue , typename >

template<typename F >

void cms::alpakatools::ScopedContextTask< TQueue, typename >::pushNextTask ( F &&  f )

inline

Definition at line 267 of file ScopedContext.h.

References cms::alpakatools::ScopedContextTask< TQueue, typename >::contextState_, f, cms::alpakatools::ScopedContextTask< TQueue, typename >::holderHelper_, and cms::alpakatools::impl::ScopedContextHolderHelper::pushNextTask().

                             {
      holderHelper_.pushNextTask(std::forward<F>(f), contextState_);
    }

queue()

template<typename TQueue , typename >

Queue& cms::alpakatools::impl::ScopedContextBase< TQueue, typename >::queue

inline

Definition at line 39 of file ScopedContext.h.

{ return *queue_; }

queuePtr()

template<typename TQueue , typename >

const std::shared_ptr<Queue>& cms::alpakatools::impl::ScopedContextBase< TQueue, typename >::queuePtr

inline

Definition at line 40 of file ScopedContext.h.

{ return queue_; }

replaceWaitingTaskHolder()

template<typename TQueue , typename >

void cms::alpakatools::ScopedContextTask< TQueue, typename >::replaceWaitingTaskHolder ( edm::WaitingTaskWithArenaHolder  waitingTaskHolder )

inline

Definition at line 271 of file ScopedContext.h.

References cms::alpakatools::ScopedContextTask< TQueue, typename >::holderHelper_, eostools::move(), and cms::alpakatools::impl::ScopedContextHolderHelper::replaceWaitingTaskHolder().

                                                                                   {
      holderHelper_.replaceWaitingTaskHolder(std::move(waitingTaskHolder));
    }

Member Data Documentation

contextState_

template<typename TQueue , typename >

ContextState<Queue> const* cms::alpakatools::ScopedContextTask< TQueue, typename >::contextState_

private

Definition at line 277 of file ScopedContext.h.

Referenced by cms::alpakatools::ScopedContextTask< TQueue, typename >::pushNextTask().

holderHelper_

template<typename TQueue , typename >

impl::ScopedContextHolderHelper cms::alpakatools::ScopedContextTask< TQueue, typename >::holderHelper_

private

Definition at line 276 of file ScopedContext.h.

Referenced by cms::alpakatools::ScopedContextTask< TQueue, typename >::pushNextTask(), cms::alpakatools::ScopedContextTask< TQueue, typename >::replaceWaitingTaskHolder(), and cms::alpakatools::ScopedContextTask< TQueue, typename >::~ScopedContextTask().