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 by 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
  41 struct gmx_device_info_t;
  42
  43 /*! \brief Possible results of the GPU detection/check.
  44  *
  45  * The egpuInsane value means that during the sanity checks an error
  46  * occurred that indicates malfunctioning of the device, driver, or
  47  * incompatible driver/runtime. */
  48 typedef enum
  49 {
  50     egpuCompatible = 0,
  51     egpuNonexistent,
  52     egpuIncompatible,
  53     egpuIncompatibleClusterSize,
  54     egpuInsane,
  55     egpuNR
  56 } e_gpu_detect_res_t;
  57
  58 /*! \brief Names of the GPU detection/check results
  59  *
  60  * \todo Make a proper class enumeration with helper string */
  61 extern const char* const gpu_detect_res_str[egpuNR];
  62
  63 /*! \brief Information about GPU devices on this physical node.
  64  *
  65  * Includes either CUDA or OpenCL devices.  The gmx_hardware_detect
  66  * module initializes it.
  67  *
  68  * \todo Use a std::vector */
  69 struct gmx_gpu_info_t
  70 {
  71     //! Did we attempt GPU detection?
  72     gmx_bool bDetectGPUs;
  73     //! Total number of GPU devices detected on this physical node
  74     int n_dev;
  75     //! Information about each GPU device detected on this physical node
  76     gmx_device_info_t* gpu_dev;
  77     //! Number of GPU devices detected on this physical node that are compatible.
  78     int n_dev_compatible;
  79 };
  80
  81 #endif