Gaudi::CUDA::Stream Class Reference

#include </builds/gaudi/Gaudi/GaudiCUDA/include/Gaudi/CUDA/CUDAStream.h>

Collaboration diagram for Gaudi::CUDA::Stream:

Public Member Functions
	Stream (const Gaudi::Algorithm *parent, cudaStream_t stream)
	Wrap an existing cudaStream.
	Stream (const Gaudi::Algorithm *parent)
	Obtain a cudaStream from the pool.
	~Stream ()
	operator cudaStream_t ()
	Access the internal cudaStream_t.
const Gaudi::Algorithm *	parent ()
	Access the parent algorithm.
const Gaudi::AsynchronousAlgorithm *	asyncParent ()
	Access the parent AsynchronousAlgorithm.
StatusCode	await ()
	Yield fiber until stream is done.
void	registerDependency ()
	INTERNAL: Register a dependency.
void	removeDependency ()
	INTERNAL: Remove a dependency.

Private Attributes
cudaStream_t	m_stream
const bool	m_owning
const Gaudi::Algorithm *	m_parent
const Gaudi::AsynchronousAlgorithm *	m_async_parent
int	m_dependents

Detailed Description

Definition at line 20 of file CUDAStream.h.

Constructor & Destructor Documentation

Stream() [1/2]

Gaudi::CUDA::Stream::Stream	(	const Gaudi::Algorithm *	parent,
		cudaStream_t	stream )

Wrap an existing cudaStream.

Definition at line 78 of file CUDAStream.cpp.

      : m_stream( stream )
      , m_owning( stream == nullptr )
      , m_parent( parent )
      , m_async_parent( dynamic_cast<const Gaudi::AsynchronousAlgorithm*>( parent ) )
      , m_dependents( 0 ) {}

Stream() [2/2]

Gaudi::CUDA::Stream::Stream

(

const Gaudi::Algorithm *

parent

)

Obtain a cudaStream from the pool.

Definition at line 85 of file CUDAStream.cpp.

                                               : Stream( parent, nullptr ) {
    if ( !available_streams.pop( m_stream ) ) {
      cudaError_t err = cudaStreamCreate( &m_stream );
      if ( err != cudaSuccess ) {
        cudaGetLastError();
        throw GaudiException( err_fmt( err, __FILE__, __LINE__ ), "CUDAStreamException", StatusCode::FAILURE );
      }
      err = cudaStreamSynchronize( m_stream );
      if ( err != cudaSuccess ) {
        cudaGetLastError();
        throw GaudiException( err_fmt( err, __FILE__, __LINE__ ), "CUDAStreamException", StatusCode::FAILURE );
      }
    }
  }

~Stream()

Gaudi::CUDA::Stream::~Stream

(

)

Definition at line 100 of file CUDAStream.cpp.

                  {
    if ( m_dependents != 0 ) {
      m_parent->error() << std::format( "Stream destroyed before all its dependents ({} remaining)", m_dependents )
                        << endmsg;
    }
    if ( await().isFailure() ) { m_parent->error() << "Error in Stream destructor" << endmsg; }
    if ( m_owning ) { available_streams.push( m_stream ); }
  }

Member Function Documentation

asyncParent()

const Gaudi::AsynchronousAlgorithm * Gaudi::CUDA::Stream::asyncParent

(

)

Access the parent AsynchronousAlgorithm.

Definition at line 112 of file CUDAStream.cpp.

{ return m_async_parent; }

await()

StatusCode Gaudi::CUDA::Stream::await

(

)

Yield fiber until stream is done.

Definition at line 114 of file CUDAStream.cpp.

                           {
    auto temp_error = cudaSuccess;
    if ( m_async_parent != nullptr ) {
      auto sc = m_async_parent->decorateSuspension( [this, &temp_error]() {
        auto res   = boost::fibers::cuda::waitfor_all( m_stream );
        temp_error = std::get<1>( res );
        return StatusCode::SUCCESS;
      } );
      if ( !sc.isSuccess() ) {
        m_parent->error() << "Error suspending on stream " << endmsg;
        return sc;
      }
    } else {
      temp_error = cudaStreamSynchronize( m_stream );
    }
    if ( ( temp_error ) != cudaSuccess ) {
      cudaGetLastError();
      std::string errmsg = err_fmt( temp_error, __FILE__, __LINE__ );
      m_parent->error() << errmsg << endmsg;
      return StatusCode::FAILURE;
    }
    return StatusCode::SUCCESS;
  }

operator cudaStream_t()

Gaudi::CUDA::Stream::operator cudaStream_t

(

)

Access the internal cudaStream_t.

Definition at line 109 of file CUDAStream.cpp.

{ return m_stream; }

parent()

const Gaudi::Algorithm * Gaudi::CUDA::Stream::parent

(

)

Access the parent algorithm.

Definition at line 111 of file CUDAStream.cpp.

{ return m_parent; }

registerDependency()

void Gaudi::CUDA::Stream::registerDependency

(

)

INTERNAL: Register a dependency.

Definition at line 138 of file CUDAStream.cpp.

{ ++m_dependents; }

removeDependency()

void Gaudi::CUDA::Stream::removeDependency

(

)

INTERNAL: Remove a dependency.

Definition at line 139 of file CUDAStream.cpp.

{ --m_dependents; }

Member Data Documentation

m_async_parent

const Gaudi::AsynchronousAlgorithm* Gaudi::CUDA::Stream::m_async_parent

private

Definition at line 25 of file CUDAStream.h.

m_dependents

int Gaudi::CUDA::Stream::m_dependents

private

Definition at line 26 of file CUDAStream.h.

m_owning

const bool Gaudi::CUDA::Stream::m_owning

private

Definition at line 23 of file CUDAStream.h.

m_parent

const Gaudi::Algorithm* Gaudi::CUDA::Stream::m_parent

private

Definition at line 24 of file CUDAStream.h.

m_stream

cudaStream_t Gaudi::CUDA::Stream::m_stream

private

Definition at line 22 of file CUDAStream.h.

---

The documentation for this class was generated from the following files:

• GaudiCUDA/include/Gaudi/CUDA/CUDAStream.h
• GaudiCUDA/src/CUDAStream.cpp