src/gromacs/hardware/gpu_hw_info.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   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.
   9  *
  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.
  14  *
  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.
  19  *
  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.
  24  *
  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.
  32  *
  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.
  35  */
  36 #ifndef GMX_HARDWARE_GPU_HW_INFO_H
  37 #define GMX_HARDWARE_GPU_HW_INFO_H
  38
  39 #include "gromacs/utility/basedefinitions.h"
  40 #include "gromacs/utility/enumerationhelpers.h"
  41
  42 struct DeviceInformation;
  43
  44 //! Possible results of the GPU detection/check.
  45 enum class DeviceStatus : int
  46 {
  47     //! The device is compatible
  48     Compatible = 0,
  49     //! Device does not exist
  50     Nonexistent = 1,
  51     //! Device is not compatible
  52     Incompatible = 2,
  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.
  57      */
  58     NonFunctional = 4,
  59     /*! \brief CUDA devices are busy or unavailable.
  60      * typically due to use of \p cudaComputeModeExclusive, \p cudaComputeModeProhibited modes.
  61      */
  62     Unavailable = 5,
  63     //! Enumeration size
  64     Count = 6
  65 };
  66
  67 /*! \brief Names of the GPU detection/check results
  68  *
  69  * Check-source wants to warn about the use of a symbol name that would
  70  * require an inclusion of config.h. However the use is in a comment, so that
  71  * is a false warning. So C-style string concatenation is used to fool the
  72  * naive parser in check-source. That needs a clang-format suppression
  73  * in order to look reasonable. Also clang-tidy wants to suggest that a comma is
  74  * missing, so that is suppressed.
  75  */
  76 static const gmx::EnumerationArray<DeviceStatus, const char*> c_deviceStateString = {
  77     "compatible", "nonexistent", "incompatible",
  78     // clang-format off
  79     // NOLINTNEXTLINE(bugprone-suspicious-missing-comma)
  80     "incompatible (please recompile with correct GMX" "_OPENCL_NB_CLUSTER_SIZE of 4)",
  81     // clang-format on
  82     "non-functional", "unavailable"
  83 };
  84
  85 /*! \brief Information about GPU devices on this physical node.
  86  *
  87  * Includes either CUDA or OpenCL devices.  The gmx_hardware_detect
  88  * module initializes it.
  89  *
  90  * \todo Use a std::vector */
  91 struct gmx_gpu_info_t
  92 {
  93     //! Did we attempt GPU detection?
  94     gmx_bool bDetectGPUs;
  95     //! Total number of GPU devices detected on this physical node
  96     int n_dev;
  97     //! Information about each GPU device detected on this physical node
  98     DeviceInformation* deviceInfo;
  99     //! Number of GPU devices detected on this physical node that are compatible.
 100     int n_dev_compatible;
 101 };
 102
 103 #endif