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,2018,2019, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 #ifndef GMX_HARDWARE_GPU_HW_INFO_H
  36 #define GMX_HARDWARE_GPU_HW_INFO_H
  37
  38 #include "gromacs/utility/basedefinitions.h"
  39
  40 struct gmx_device_info_t;
  41
  42 /*! \brief Possible results of the GPU detection/check.
  43  *
  44  * The egpuInsane value means that during the sanity checks an error
  45  * occurred that indicates malfunctioning of the device, driver, or
  46  * incompatible driver/runtime. */
  47 typedef enum
  48 {
  49     egpuCompatible = 0,
  50     egpuNonexistent,
  51     egpuIncompatible,
  52     egpuIncompatibleClusterSize,
  53     egpuInsane,
  54     egpuNR
  55 } e_gpu_detect_res_t;
  56
  57 /*! \brief Names of the GPU detection/check results
  58  *
  59  * \todo Make a proper class enumeration with helper string */
  60 extern const char* const gpu_detect_res_str[egpuNR];
  61
  62 /*! \brief Information about GPU devices on this physical node.
  63  *
  64  * Includes either CUDA or OpenCL devices.  The gmx_hardware_detect
  65  * module initializes it.
  66  *
  67  * \todo Use a std::vector */
  68 struct gmx_gpu_info_t
  69 {
  70     //! Did we attempt GPU detection?
  71     gmx_bool bDetectGPUs;
  72     //! Total number of GPU devices detected on this physical node
  73     int n_dev;
  74     //! Information about each GPU device detected on this physical node
  75     gmx_device_info_t* gpu_dev;
  76     //! Number of GPU devices detected on this physical node that are compatible.
  77     int n_dev_compatible;
  78 };
  79
  80 #endif