cms::cuda::ContextState Class Reference

#include <ContextState.h>

Public Member Functions
	ContextState ()=default
	ContextState (const ContextState &)=delete
	ContextState (ContextState &&)=delete
ContextState &	operator= (const ContextState &)=delete
ContextState &	operator= (ContextState &&other)=delete
	~ContextState ()=default

Private Member Functions
int	device () const
SharedStreamPtr	releaseStreamPtr ()
void	set (int device, SharedStreamPtr stream)
const SharedStreamPtr &	streamPtr () const
void	throwIfNoStream () const
void	throwIfStream () const

Private Attributes
int	device_
SharedStreamPtr	stream_

Friends
class	ScopedContextAcquire
class	ScopedContextProduce
class	ScopedContextTask

Detailed Description

The purpose of this class is to deliver the device and CUDA stream information from ExternalWork's acquire() to producer() via a member/StreamCache variable.

Definition at line 15 of file ContextState.h.

Constructor & Destructor Documentation

ContextState() [1/3]

cms::cuda::ContextState::ContextState ( )

default

~ContextState()

cms::cuda::ContextState::~ContextState ( )

default

ContextState() [2/3]

cms::cuda::ContextState::ContextState ( const ContextState &  )

delete

ContextState() [3/3]

cms::cuda::ContextState::ContextState ( ContextState &&  )

delete

Member Function Documentation

device()

int cms::cuda::ContextState::device ( ) const

inlineprivate

Definition at line 36 of file ContextState.h.

{ return device_; }

References device_.

Referenced by set().

operator=() [1/2]

ContextState& cms::cuda::ContextState::operator= ( const ContextState &  )

delete

operator=() [2/2]

ContextState& cms::cuda::ContextState::operator= ( ContextState &&  other )

delete

releaseStreamPtr()

SharedStreamPtr cms::cuda::ContextState::releaseStreamPtr ( )

inlineprivate

Definition at line 43 of file ContextState.h.

                                         {
        throwIfNoStream();
        // This function needs to effectively reset stream_ (i.e. stream_
        // must be empty after this function). This behavior ensures that
        // the SharedStreamPtr is not hold for inadvertedly long (i.e. to
        // the next event), and is checked at run time.
        return std::move(stream_);
      }

References eostools::move(), stream_, and throwIfNoStream().

set()

void cms::cuda::ContextState::set ( int  device, SharedStreamPtr  stream  )

inlineprivate

Definition at line 30 of file ContextState.h.

                                                   {
        throwIfStream();
        device_ = device;
        stream_ = std::move(stream);
      }

References device(), device_, eostools::move(), cms::cuda::stream, stream_, and throwIfStream().

Referenced by cms::cuda::ScopedContextAcquire::~ScopedContextAcquire().

streamPtr()

const SharedStreamPtr& cms::cuda::ContextState::streamPtr ( ) const

inlineprivate

Definition at line 38 of file ContextState.h.

                                               {
        throwIfNoStream();
        return stream_;
      }

References stream_, and throwIfNoStream().

throwIfNoStream()

void cms::cuda::ContextState::throwIfNoStream ( ) const

private

Definition at line 11 of file ContextState.cc.

                                           {
    if (not stream_) {
      throw cms::Exception("LogicError") << "Trying to get ContextState, but it did not have a valid state";
    }
  }

References Exception, and stream_.

Referenced by releaseStreamPtr(), and streamPtr().

throwIfStream()

void cms::cuda::ContextState::throwIfStream ( ) const

private

Definition at line 5 of file ContextState.cc.

                                         {
    if (stream_) {
      throw cms::Exception("LogicError") << "Trying to set ContextState, but it already had a valid state";
    }
  }

References Exception, and stream_.

Referenced by set().

Friends And Related Function Documentation

ScopedContextAcquire

friend class ScopedContextAcquire

friend

Definition at line 26 of file ContextState.h.

ScopedContextProduce

friend class ScopedContextProduce

friend

Definition at line 27 of file ContextState.h.

ScopedContextTask

friend class ScopedContextTask

friend

Definition at line 28 of file ContextState.h.

Member Data Documentation

device_

int cms::cuda::ContextState::device_

private

Definition at line 56 of file ContextState.h.

Referenced by device(), and set().

stream_

SharedStreamPtr cms::cuda::ContextState::stream_

private

Definition at line 55 of file ContextState.h.

Referenced by releaseStreamPtr(), set(), streamPtr(), throwIfNoStream(), and throwIfStream().