DeviceStream Class Reference

#include <gromacs/gpu_utils/device_stream.h>

Description

Declaration of platform-agnostic device stream/queue.

The command stream (or command queue) is a sequence of operations that are executed in they order they were issued. Several streams may co-exist to represent concurrency. This class declares the interfaces, that are exposed to platform-agnostic code and it should be implemented for each compute architecture.

Destruction of the DeviceStream calls the destructor of the underlying low-level stream/queue, hence should only be called when the stream is no longer needed. To prevent accidental stream destruction, while copying or moving a DeviceStream object, copy and move constructors and copy and move assignments are not allowed and the DeviceStream object should be passed as a pointer or constant reference.

Public Member Functions
	DeviceStream (const DeviceContext &deviceContext, DeviceStreamPriority priority, bool useTiming)
	Construct and init. More...
	~DeviceStream ()
	Destructor.
bool	isValid () const
	Check if the underlying stream is valid. More...
void	synchronize () const
	Synchronize the stream.
cl_command_queue	stream () const
	Getter.

Constructor & Destructor Documentation

DeviceStream::DeviceStream	(	const DeviceContext &	deviceContext,
		DeviceStreamPriority	priority,
		bool	useTiming
	)

Construct and init.

Parameters

[in]	deviceContext	Device context.
[in]	priority	Stream priority: high or normal (ignored in OpenCL).
[in]	useTiming	If the timing should be enabled (ignored in CUDA).

Member Function Documentation

bool DeviceStream::isValid

(

)

const

Check if the underlying stream is valid.

Returns

Whether the stream is valid (false in CPU-only builds).

---

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

• src/gromacs/gpu_utils/device_stream.h
• src/gromacs/gpu_utils/device_stream.cpp
• src/gromacs/gpu_utils/device_stream_hip.cpp
• src/gromacs/gpu_utils/device_stream_ocl.cpp
• src/gromacs/gpu_utils/device_stream_sycl.cpp