AthHIP::Details::Stream Class Reference

Helper class for managing a HIP stream in memory. More...

#include <Stream.h>

Collaboration diagram for AthHIP::Details::Stream:

Public Member Functions
	Stream ()
	Constructor, creating the HIP stream.
	~Stream ()
	Destructor, destroying the HIP stream.
hipStream_t	stream () const
	Get the HIP stream.
std::string	name () const
	Get the name of the device associated with the stream.

Private Attributes
hipStream_t	m_stream {nullptr}
	The HIP stream to use for asynchronous copies.

Detailed Description

Helper class for managing a HIP stream in memory.

Definition at line 16 of file AthHIP/AthHIPComps/src/Stream.h.

Constructor & Destructor Documentation

Stream()

AthHIP::Details::Stream::Stream

(

)

Constructor, creating the HIP stream.

Definition at line 28 of file AthHIP/AthHIPComps/src/Stream.cxx.

               {
  HIP_ERROR_CHECK(hipStreamCreate(&m_stream));
}

~Stream()

AthHIP::Details::Stream::~Stream

(

)

Destructor, destroying the HIP stream.

Let's not check for errors here.

Since that would introduce a struct that may throw in its destructor. Which we don't want.

Definition at line 34 of file AthHIP/AthHIPComps/src/Stream.cxx.

                {
  [[maybe_unused]] hipError_t error = hipStreamDestroy(m_stream);
}

Member Function Documentation

name()

std::string AthHIP::Details::Stream::name

(

)

const

Get the name of the device associated with the stream.

Definition at line 48 of file AthHIP/AthHIPComps/src/Stream.cxx.

                             {
 
  // Get the device's properties.
  int device = -1;
  HIP_ERROR_CHECK(hipStreamGetDevice(stream(), &device));
  hipDeviceProp_t props;
  HIP_ERROR_CHECK(hipGetDeviceProperties(&props, device));
 
  // Construct a unique name out of those properties.
  return std::format("{} [id: {}, bus: {}, device: {}]", props.name, device,
                     props.pciBusID, props.pciDeviceID);
}

stream()

hipStream_t AthHIP::Details::Stream::stream

(

)

const

Get the HIP stream.

Definition at line 38 of file AthHIP/AthHIPComps/src/Stream.cxx.

                                 {
 
  // The HIP runtime promises thread safety for handling streams in parallel
  // from different CPU threads. Returning a non-const pointer of course allows
  // us to cause harm. But as long as user code is not trying to actively break
  // things, we should be fine.
  hipStream_t result ATLAS_THREAD_SAFE = m_stream;
  return result;
}

Member Data Documentation

m_stream

hipStream_t AthHIP::Details::Stream::m_stream {nullptr}

private

The HIP stream to use for asynchronous copies.

Definition at line 32 of file AthHIP/AthHIPComps/src/Stream.h.

{nullptr};

---

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

• AthHIP/AthHIPComps/src/Stream.h
• AthHIP/AthHIPComps/src/Stream.cxx