device_information.h File Reference

#include "config.h"
#include <cstddef>
#include <array>
#include <optional>
#include <type_traits>
#include "gromacs/utility/arrayref.h"
#include "gromacs/utility/enumerationhelpers.h"
#include "gromacs/utility/fixedcapacityvector.h"
#include "gromacs/utility/mpiinfo.h"

Include dependency graph for device_information.h:

This graph shows which files directly or indirectly include this file:

Description

Declares the GPU information structure and its helpers.

Author

Anca Hamuraru anca@.nosp@m.stre.nosp@m.amcom.nosp@m.puti.nosp@m.ng.eu

Dimitrios Karkoulis dimit.nosp@m.ris..nosp@m.karko.nosp@m.ulis.nosp@m.@gmai.nosp@m.l.co.nosp@m.m

Teemu Virolainen teemu.nosp@m.@str.nosp@m.eamco.nosp@m.mput.nosp@m.ing.e.nosp@m.u

Mark Abraham mark..nosp@m.j.ab.nosp@m.raham.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Szilárd Páll pall..nosp@m.szil.nosp@m.ard@g.nosp@m.mail.nosp@m..com

Artem Zhmurov zhmur.nosp@m.ov@g.nosp@m.mail..nosp@m.com

Classes
struct	DeviceInformation
	Platform-dependent device information. More...

Enumerations
enum	DeviceStatus : int {   DeviceStatus::Compatible, DeviceStatus::Nonexistent, DeviceStatus::Incompatible, DeviceStatus::IncompatibleClusterSize,   DeviceStatus::IncompatibleNvidiaVolta, DeviceStatus::NotPreferredBackend, DeviceStatus::NonFunctional, DeviceStatus::Unavailable,   DeviceStatus::DeviceNotTargeted, DeviceStatus::IncompatibleOclAmdRdna, DeviceStatus::IncompatibleAmdRdnaNotTargeted, DeviceStatus::Count }
	Possible results of the GPU detection/check. More...
enum	DeviceVendor : int {   DeviceVendor::Unknown = 0, DeviceVendor::Nvidia = 1, DeviceVendor::Amd = 2, DeviceVendor::Intel = 3,   DeviceVendor::Apple = 4, DeviceVendor::Count = 5 }
	Device vendors. More...

Variables
static constexpr bool	c_binarySupportsGpus = (GMX_GPU != 0)
	Constant used to help minimize preprocessed code.
static const gmx::EnumerationArray < DeviceStatus, const char * >	c_deviceStateString
	Names of the GPU detection/check results. More...
static constexpr bool	c_canSerializeDeviceInformation = std::is_trivially_copyable_v<DeviceInformation>
	Whether DeviceInformation can be serialized for sending via MPI.

Enumeration Type Documentation

enum DeviceStatus : int

strong

Possible results of the GPU detection/check.

Enumerator
Compatible	The device is compatible.
Nonexistent	Device does not exist.
Incompatible	Device is not compatible.
IncompatibleClusterSize	OpenCL/SYCL device has incompatible cluster size for non-bonded kernels.
IncompatibleNvidiaVolta	There are known issues with OpenCL on NVIDIA Volta and newer.
NotPreferredBackend	The device originates from non-recommended SYCL backend. The device might work by itself, but to simplify device allocation, it is marked as incompatible.
NonFunctional	An error occurred during the functionality checks. That indicates malfunctioning of the device, driver, or incompatible driver/runtime.
Unavailable	CUDA devices are busy or unavailable. typically due to use of cudaComputeModeExclusive, cudaComputeModeProhibited modes.
DeviceNotTargeted	The device is outside the set of compilation targets. See GMX_CUDA_TARGET_SM and GMX_CUDA_TARGET_COMPUTE CMake variables.
IncompatibleOclAmdRdna	AMD RDNA devices (gfx10xx, gfx11xx) with 32-wide execution are not supported with OpenCL,.
IncompatibleAmdRdnaNotTargeted	RDNA not targeted (SYCL)
Count	Enumeration size.

enum DeviceVendor : int

strong

Device vendors.

Enumerator
Unknown	No data.
Nvidia	NVIDIA.
Amd	Advanced Micro Devices.
Intel	Intel.
Apple	Apple.
Count	Enumeration size.

Variable Documentation

const gmx::EnumerationArray<DeviceStatus, const char*> c_deviceStateString

static

Initial value:

= {
    "compatible",
    "nonexistent",
    "incompatible",
    
    
    "incompatible (please recompile with correct GMX" "_GPU_NB_CLUSTER_SIZE)",
    
    "incompatible (please use CUDA build for NVIDIA Volta GPUs or newer)",
    "not recommended (please use ONEAPI_DEVICE_SELECTOR to limit visibility to a single backend)",
    "non-functional",
    "unavailable",
    "not in set of targeted devices",
    "incompatible (AMD RDNA devices are not supported)", 
    
    
    "incompatible (please recompile with GMX" "_ENABLE_AMD_RDNA_SUPPORT)"
    
}

Names of the GPU detection/check results.

Check-source wants to warn about the use of a symbol name that would require an inclusion of config.h. However the use is in a comment, so that is a false warning. So C-style string concatenation is used to fool the naive parser in check-source. That needs a clang-format suppression in order to look reasonable. Also clang-tidy wants to suggest that a comma is missing, so that is suppressed.