cms::cuda::ScopedContextAcquire Class Reference

#include <ScopedContext.h>

Inheritance diagram for cms::cuda::ScopedContextAcquire:

Public Member Functions
template<typename F >
void	pushNextTask (F &&f)
void	replaceWaitingTaskHolder (edm::WaitingTaskWithArenaHolder waitingTaskHolder)
	ScopedContextAcquire (edm::StreamID streamID, edm::WaitingTaskWithArenaHolder waitingTaskHolder)
	Constructor to create a new CUDA stream (no need for context beyond acquire()) More...
	ScopedContextAcquire (edm::StreamID streamID, edm::WaitingTaskWithArenaHolder waitingTaskHolder, ContextState &state)
	Constructor to create a new CUDA stream, and the context is needed after acquire() More...
	ScopedContextAcquire (const ProductBase &data, edm::WaitingTaskWithArenaHolder waitingTaskHolder)
	Constructor to (possibly) re-use a CUDA stream (no need for context beyond acquire()) More...
	ScopedContextAcquire (const ProductBase &data, edm::WaitingTaskWithArenaHolder waitingTaskHolder, ContextState &state)
	Constructor to (possibly) re-use a CUDA stream, and the context is needed after acquire() More...
	~ScopedContextAcquire () noexcept(false)
Public Member Functions inherited from cms::cuda::impl::ScopedContextGetterBase
template<typename T >
const T &	get (const Product< T > &data)
template<typename T >
const T &	get (const edm::Event &iEvent, edm::EDGetTokenT< Product< T >> token)
Public Member Functions inherited from cms::cuda::impl::ScopedContextBase
int	device () const
cudaStream_t	stream () const
const SharedStreamPtr &	streamPtr () const

Private Member Functions
void	throwNoState ()

Private Attributes
ContextState *	contextState_ = nullptr
impl::ScopedContextHolderHelper	holderHelper_

Additional Inherited Members
Protected Member Functions inherited from cms::cuda::impl::ScopedContextGetterBase
template<typename... Args>
	ScopedContextGetterBase (Args &&... args)
void	synchronizeStreams (int dataDevice, cudaStream_t dataStream, bool available, cudaEvent_t dataEvent)
Protected Member Functions inherited from cms::cuda::impl::ScopedContextBase
	ScopedContextBase (edm::StreamID streamID)
	ScopedContextBase (const ProductBase &data)
	ScopedContextBase (int device, SharedStreamPtr stream)

Detailed Description

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

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

Definition at line 101 of file ScopedContext.h.

Constructor & Destructor Documentation

ScopedContextAcquire() [1/4]

cms::cuda::ScopedContextAcquire::ScopedContextAcquire ( edm::StreamID  streamID, edm::WaitingTaskWithArenaHolder  waitingTaskHolder  )

inlineexplicit

Constructor to create a new CUDA stream (no need for context beyond acquire())

Definition at line 104 of file ScopedContext.h.

References eostools::move().

          : ScopedContextGetterBase(streamID), holderHelper_{std::move(waitingTaskHolder)} {}

ScopedContextAcquire() [2/4]

cms::cuda::ScopedContextAcquire::ScopedContextAcquire ( edm::StreamID  streamID, edm::WaitingTaskWithArenaHolder  waitingTaskHolder, ContextState &  state  )

inlineexplicit

Constructor to create a new CUDA stream, and the context is needed after acquire()

Definition at line 108 of file ScopedContext.h.

References eostools::move().

          : ScopedContextGetterBase(streamID), holderHelper_{std::move(waitingTaskHolder)}, contextState_{&state} {}

ScopedContextAcquire() [3/4]

cms::cuda::ScopedContextAcquire::ScopedContextAcquire ( const ProductBase &  data, edm::WaitingTaskWithArenaHolder  waitingTaskHolder  )

inlineexplicit

Constructor to (possibly) re-use a CUDA stream (no need for context beyond acquire())

Definition at line 114 of file ScopedContext.h.

References eostools::move().

          : ScopedContextGetterBase(data), holderHelper_{std::move(waitingTaskHolder)} {}

ScopedContextAcquire() [4/4]

cms::cuda::ScopedContextAcquire::ScopedContextAcquire ( const ProductBase &  data, edm::WaitingTaskWithArenaHolder  waitingTaskHolder, ContextState &  state  )

inlineexplicit

Constructor to (possibly) re-use a CUDA stream, and the context is needed after acquire()

Definition at line 118 of file ScopedContext.h.

References eostools::move().

          : ScopedContextGetterBase(data), holderHelper_{std::move(waitingTaskHolder)}, contextState_{&state} {}

~ScopedContextAcquire()

cms::cuda::ScopedContextAcquire::~ScopedContextAcquire ( )

noexcept

Definition at line 71 of file ScopedContext.cc.

References contextState_, cms::cuda::impl::ScopedContextBase::device(), cms::cuda::impl::ScopedContextHolderHelper::enqueueCallback(), holderHelper_, cms::cuda::ContextState::set(), cms::cuda::impl::ScopedContextBase::stream(), and cms::cuda::impl::ScopedContextBase::streamPtr().

                                                              {
    holderHelper_.enqueueCallback(device(), stream());
    if (contextState_) {
      contextState_->set(device(), streamPtr());
    }
  }

Member Function Documentation

pushNextTask()

template<typename F >

void cms::cuda::ScopedContextAcquire::pushNextTask ( F &&  f )

inline

Definition at line 126 of file ScopedContext.h.

References contextState_, f, holderHelper_, cms::cuda::impl::ScopedContextHolderHelper::pushNextTask(), and throwNoState().

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

replaceWaitingTaskHolder()

void cms::cuda::ScopedContextAcquire::replaceWaitingTaskHolder ( edm::WaitingTaskWithArenaHolder  waitingTaskHolder )

inline

Definition at line 132 of file ScopedContext.h.

References holderHelper_, eostools::move(), and cms::cuda::impl::ScopedContextHolderHelper::replaceWaitingTaskHolder().

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

throwNoState()

void cms::cuda::ScopedContextAcquire::throwNoState ( )

private

Definition at line 78 of file ScopedContext.cc.

References Exception.

Referenced by pushNextTask().

                                          {
    throw cms::Exception("LogicError")
        << "Calling ScopedContextAcquire::insertNextTask() requires ScopedContextAcquire to be constructed with "
           "ContextState, but that was not the case";
  }

Member Data Documentation

contextState_

ContextState* cms::cuda::ScopedContextAcquire::contextState_ = nullptr

private

Definition at line 140 of file ScopedContext.h.

Referenced by pushNextTask(), and ~ScopedContextAcquire().

holderHelper_

impl::ScopedContextHolderHelper cms::cuda::ScopedContextAcquire::holderHelper_

private

Definition at line 139 of file ScopedContext.h.

Referenced by pushNextTask(), replaceWaitingTaskHolder(), and ~ScopedContextAcquire().