2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013,2014,2015,2017 The GROMACS development team.
5 * Copyright (c) 2018,2019,2020, by the GROMACS development team, led by
6 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
7 * and including many others, as listed in the AUTHORS file in the
8 * top-level source directory and at http://www.gromacs.org.
10 * GROMACS is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public License
12 * as published by the Free Software Foundation; either version 2.1
13 * of the License, or (at your option) any later version.
15 * GROMACS is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with GROMACS; if not, see
22 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
23 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 * If you want to redistribute modifications to GROMACS, please
26 * consider that scientific software is very special. Version
27 * control is crucial - bugs must be traceable. We will be happy to
28 * consider code for inclusion in the official distribution, but
29 * derived work must not be called official GROMACS. Details are found
30 * in the README & COPYING files - if they are missing, get the
31 * official version at http://www.gromacs.org.
33 * To help us fund GROMACS development, we humbly ask that you cite
34 * the research papers on the package. Check out http://www.gromacs.org.
36 #ifndef GMX_HARDWARE_GPU_HW_INFO_H
37 #define GMX_HARDWARE_GPU_HW_INFO_H
39 #include "gromacs/utility/basedefinitions.h"
40 #include "gromacs/utility/enumerationhelpers.h"
42 struct DeviceInformation;
44 //! Possible results of the GPU detection/check.
45 enum class DeviceStatus : int
47 //! The device is compatible
49 //! Device does not exist
51 //! Device is not compatible
53 //! OpenCL device has incompatible cluster size for non-bonded kernels.
54 IncompatibleClusterSize = 3,
55 /*! \brief An error occurred he functionality checks.
56 * That indicates malfunctioning of the device, driver, or incompatible driver/runtime.
59 /*! \brief CUDA devices are busy or unavailable.
60 * typically due to use of \p cudaComputeModeExclusive, \p cudaComputeModeProhibited modes.
67 /*! \brief Names of the GPU detection/check results
69 static const gmx::EnumerationArray<DeviceStatus, const char*> c_deviceStateString = {
70 "compatible", "nonexistent",
71 "incompatible", "incompatible (please recompile with GMX_OPENCL_NB_CLUSTER_SIZE=4)",
72 "non-functional", "unavailable"
75 /*! \brief Information about GPU devices on this physical node.
77 * Includes either CUDA or OpenCL devices. The gmx_hardware_detect
78 * module initializes it.
80 * \todo Use a std::vector */
83 //! Did we attempt GPU detection?
85 //! Total number of GPU devices detected on this physical node
87 //! Information about each GPU device detected on this physical node
88 DeviceInformation* deviceInfo;
89 //! Number of GPU devices detected on this physical node that are compatible.