1 /* 2 * This file is part of the GROMACS molecular simulation package. 3 * 4 * Copyright (c) 2012,2013,2014,2015,2016, by the GROMACS development team. 5 * Copyright (c) 2017,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 /*! \libinternal \file 37 * \brief Declares the GPU information structure and its helpers 38 * 39 * \author Anca Hamuraru <anca@streamcomputing.eu> 40 * \author Dimitrios Karkoulis <dimitris.karkoulis@gmail.com> 41 * \author Teemu Virolainen <teemu@streamcomputing.eu> 42 * \author Mark Abraham <mark.j.abraham@gmail.com> 43 * \author Szilárd Páll <pall.szilard@gmail.com> 44 * \author Artem Zhmurov <zhmurov@gmail.com> 45 */ 46 #ifndef GMX_HARDWARE_DEVICE_INFORMATION_H 47 #define GMX_HARDWARE_DEVICE_INFORMATION_H 48 49 #include "config.h" 50 51 #if GMX_GPU_CUDA 52 # include <cuda_runtime.h> 53 #endif 54 55 #if GMX_GPU_OPENCL 56 # include "gromacs/gpu_utils/gmxopencl.h" 57 #endif 58 59 #if GMX_GPU_SYCL 60 # include "gromacs/gpu_utils/gmxsycl.h" 61 #endif 62 63 #include "gromacs/utility/enumerationhelpers.h" 64 65 //! Constant used to help minimize preprocessed code 66 static constexpr bool c_binarySupportsGpus = (GMX_GPU != 0); 67 static constexpr bool c_canSerializeDeviceInformation = 68 (!GMX_GPU_OPENCL && !GMX_GPU_SYCL); /*NOLINT(misc-redundant-expression)*/ 69 70 //! Possible results of the GPU detection/check. 71 enum class DeviceStatus : int 72 { 73 //! The device is compatible 74 Compatible = 0, 75 //! Device does not exist 76 Nonexistent = 1, 77 //! Device is not compatible 78 Incompatible = 2, 79 //! OpenCL device has incompatible cluster size for non-bonded kernels. 80 IncompatibleClusterSize = 3, 81 //! There are known issues with NVIDIA Volta and newer. 82 IncompatibleNvidiaVolta = 4, 83 /*! \brief An error occurred during the functionality checks. 84 * That indicates malfunctioning of the device, driver, or incompatible driver/runtime. 85 */ 86 NonFunctional = 5, 87 /*! \brief CUDA devices are busy or unavailable. 88 * typically due to use of \p cudaComputeModeExclusive, \p cudaComputeModeProhibited modes. 89 */ 90 Unavailable = 6, 91 //! Enumeration size 92 Count = 7 93 }; 94 95 /*! \brief Names of the GPU detection/check results 96 * 97 * Check-source wants to warn about the use of a symbol name that would 98 * require an inclusion of config.h. However the use is in a comment, so that 99 * is a false warning. So C-style string concatenation is used to fool the 100 * naive parser in check-source. That needs a clang-format suppression 101 * in order to look reasonable. Also clang-tidy wants to suggest that a comma is 102 * missing, so that is suppressed. 103 */ 104 static const gmx::EnumerationArray<DeviceStatus, const char*> c_deviceStateString = { 105 "compatible", "nonexistent", "incompatible", 106 // clang-format off 107 // NOLINTNEXTLINE(bugprone-suspicious-missing-comma) 108 "incompatible (please recompile with correct GMX" "_OPENCL_NB_CLUSTER_SIZE of 4)", 109 // clang-format on 110 "incompatible (please use CUDA build for NVIDIA Volta GPUs or newer)", "non-functional", 111 "unavailable" 112 }; 113 114 //! Device vendors 115 enum class DeviceVendor : int 116 { 117 //! No data 118 Unknown = 0, 119 //! NVIDIA 120 Nvidia = 1, 121 //! Advanced Micro Devices 122 Amd = 2, 123 //! Intel 124 Intel = 3, 125 //! Enumeration size 126 Count = 4 127 }; 128 129 130 /*! \libinternal \brief Platform-dependent device information. 131 * 132 * The device information is queried and set at detection and contains 133 * both information about the device/hardware returned by the runtime as well 134 * as additional data like support status. 135 */ 136 struct DeviceInformation 137 { 138 //! Device status. 139 DeviceStatus status; 140 //! ID of the device. 141 int id; 142 //! Device vendor. 143 DeviceVendor deviceVendor; 144 #if GMX_GPU_CUDA 145 //! CUDA device properties. 146 cudaDeviceProp prop; 147 #elif GMX_GPU_OPENCL 148 cl_platform_id oclPlatformId; //!< OpenCL Platform ID. 149 cl_device_id oclDeviceId; //!< OpenCL Device ID. 150 char device_name[256]; //!< Device name. 151 char device_version[256]; //!< Device version. 152 char vendorName[256]; //!< Device vendor name. 153 int compute_units; //!< Number of compute units. 154 int adress_bits; //!< Number of address bits the device is capable of. 155 size_t maxWorkItemSizes[3]; //!< Workgroup size limits (CL_DEVICE_MAX_WORK_ITEM_SIZES). 156 size_t maxWorkGroupSize; //!< Workgroup total size limit (CL_DEVICE_MAX_WORK_GROUP_SIZE). 157 #elif GMX_GPU_SYCL 158 cl::sycl::device syclDevice; 159 #endif 160 }; 161 162 #endif // GMX_HARDWARE_DEVICE_INFORMATION_H 163