Gromacs  2021-beta2-UNCHECKED
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Functions
device_management_sycl.cpp File Reference
#include "gmxpre.h"
#include "gromacs/gpu_utils/gmxsycl.h"
#include "gromacs/hardware/device_management.h"
#include "gromacs/utility/fatalerror.h"
#include "gromacs/utility/stringutil.h"
#include "device_information.h"
+ Include dependency graph for device_management_sycl.cpp:

Description

Defines the SYCL implementations of the device management.

Author
Paul Bauer paul..nosp@m.baue.nosp@m.r.q@g.nosp@m.mail.nosp@m..com
Erik Lindahl erik..nosp@m.lind.nosp@m.ahl@g.nosp@m.mail.nosp@m..com
Artem Zhmurov zhmur.nosp@m.ov@g.nosp@m.mail..nosp@m.com
Andrey Alekseenko al42a.nosp@m.nd@g.nosp@m.mail..nosp@m.com

Functions

bool isDeviceDetectionFunctional (std::string *errorMessage)
 Return whether GPU detection is functioning correctly. More...
 
static DeviceStatus isDeviceCompatible (const cl::sycl::device &syclDevice)
 Checks that device deviceInfo is compatible with GROMACS. More...
 
static bool isDeviceFunctional (const cl::sycl::device &syclDevice, std::string *errorMessage)
 Checks that device deviceInfo is sane (ie can run a kernel). More...
 
static DeviceStatus checkDevice (size_t deviceId, const DeviceInformation &deviceInfo)
 Checks that device deviceInfo is compatible and functioning. More...
 
std::vector< std::unique_ptr
< DeviceInformation > > 
findDevices ()
 Find all GPUs in the system. More...
 
void setActiveDevice (const DeviceInformation &)
 Set the active GPU. More...
 
void releaseDevice (DeviceInformation *)
 Releases the GPU device used by the active context at the time of calling (CUDA only). More...
 
std::string getDeviceInformationString (const DeviceInformation &deviceInfo)
 Formats and returns a device information string for a given GPU. More...
 

Function Documentation

static DeviceStatus checkDevice ( size_t  deviceId,
const DeviceInformation deviceInfo 
)
static

Checks that device deviceInfo is compatible and functioning.

Checks the given SYCL device for compatibility and runs a dummy kernel on it to determine whether the device functions properly.

Parameters
[in]deviceIdDevice number (internal to GROMACS).
[in]deviceInfoThe device info pointer.
Returns
The status of device.
std::vector<std::unique_ptr<DeviceInformation> > findDevices ( )

Find all GPUs in the system.

Will detect every GPU supported by the device driver in use. Must only be called if canPerformDeviceDetection() has returned true. This routine also checks for the compatibility of each device and fill the deviceInfo array with the required information on each device: ID, device properties, status.

Note that this function leaves the GPU runtime API error state clean; this is implemented ATM in the CUDA flavor. This invalidates any existing CUDA streams, allocated memory on GPU, etc.

Todo:
: Check if errors do propagate in OpenCL as they do in CUDA and whether there is a mechanism to "clear" them.
Returns
Standard vector with the list of devices found
Exceptions
InternalErrorif a GPU API returns an unexpected failure (because the call to canDetectGpus() should always prevent this occuring)
std::string getDeviceInformationString ( const DeviceInformation deviceInfo)

Formats and returns a device information string for a given GPU.

Given an index directly into the array of available GPUs, returns a formatted info string for the respective GPU which includes ID, name, compute capability, and detection status.

Parameters
[in]deviceInfoAn information on device that is to be set.
Returns
A string describing the device.
static DeviceStatus isDeviceCompatible ( const cl::sycl::device &  syclDevice)
static

Checks that device deviceInfo is compatible with GROMACS.

For now, only checks that the vendor is Intel and it is a GPU.

Parameters
[in]syclDeviceThe SYCL device pointer.
Returns
The status enumeration value for the checked device:
bool isDeviceDetectionFunctional ( std::string *  errorMessage)

Return whether GPU detection is functioning correctly.

Returns true when this is a build of GROMACS configured to support GPU usage, and a valid device driver, ICD, and/or runtime was detected.

This function is not intended to be called from build configurations that do not support GPUs, and there will be no descriptive message in that case.

Parameters
[out]errorMessageWhen returning false on a build configured with GPU support and non-nullptr was passed, the string contains a descriptive message about why GPUs cannot be detected.

Does not throw.

static bool isDeviceFunctional ( const cl::sycl::device &  syclDevice,
std::string *  errorMessage 
)
static

Checks that device deviceInfo is sane (ie can run a kernel).

Compiles and runs a dummy kernel to determine whether the given SYCL device functions properly.

Parameters
[in]syclDeviceThe device info pointer.
[out]errorMessageAn error message related to a SYCL error.
Exceptions
std::bad_allocWhen out of memory.
Returns
Whether the device passed sanity checks
void releaseDevice ( DeviceInformation deviceInfo)

Releases the GPU device used by the active context at the time of calling (CUDA only).

If deviceInfo is nullptr, then it is understood that no device was selected so no context is active to be freed. Otherwise, the context is explicitly destroyed and therefore all data uploaded to the GPU is lost. This must only be called when none of this data is required anymore, because subsequent attempts to free memory associated with the context will otherwise fail.

Calls gmx_warning upon errors.

Todo:
This should go through all the devices, not only the one currently active. Reseting only one device will not work, e.g. in CUDA tests.
Parameters
[in]deviceInfoInformation on the device to be released.
void setActiveDevice ( const DeviceInformation deviceInfo)

Set the active GPU.

This sets the device for which the device information is passed active. Essential in CUDA, where the device buffers and kernel launches are not connected to the device context. In OpenCL, checks the device vendor and makes vendor-specific performance adjustments.

Parameters
[in]deviceInfoInformation on the device to be set.

Issues a fatal error for any critical errors that occur during initialization.