2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2018,2019,2020, 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.
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.
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.
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.
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.
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.
35 #ifndef GMX_GPU_UTILS_GPUTRAITS_OCL_H
36 #define GMX_GPU_UTILS_GPUTRAITS_OCL_H
38 /*! \libinternal \file
39 * \brief Declares the OpenCL type traits.
41 * \author Aleksei Iupinov <a.yupinov@gmail.com>
42 * \author Artem Zhmurov <zhmurov@gmail.com>
45 * \ingroup module_gpu_utils
48 #include "gromacs/gpu_utils/gmxopencl.h"
49 #include "gromacs/hardware/gpu_hw_info.h"
51 //! OpenCL device vendors
52 enum class DeviceVendor : int
54 Unknown = 0, //!< No data
55 Nvidia = 1, //!< NVIDIA
56 Amd = 2, //!< Advanced Micro Devices
62 * \brief OpenCL device information.
64 * The OpenCL device information is queried and set at detection and contains
65 * both information about the device/hardware returned by the runtime as well
66 * as additional data like support status.
68 struct DeviceInformation
70 cl_platform_id oclPlatformId; //!< OpenCL Platform ID.
71 cl_device_id oclDeviceId; //!< OpenCL Device ID.
72 char device_name[256]; //!< Device name.
73 char device_version[256]; //!< Device version.
74 char vendorName[256]; //!< Device vendor name.
75 int compute_units; //!< Number of compute units.
76 int adress_bits; //!< Number of address bits the device is capable of.
77 DeviceStatus stat; //!< Device status.
78 DeviceVendor deviceVendor; //!< Device vendor.
79 size_t maxWorkItemSizes[3]; //!< Workgroup size limits (CL_DEVICE_MAX_WORK_ITEM_SIZES).
80 size_t maxWorkGroupSize; //!< Workgroup total size limit (CL_DEVICE_MAX_WORK_GROUP_SIZE).
83 //! \brief Single GPU call timing event
84 using CommandEvent = cl_event;
87 * GPU kernels scheduling description. This is same in OpenCL/CUDA.
88 * Provides reasonable defaults, one typically only needs to set the GPU stream
89 * and non-1 work sizes.
91 struct KernelLaunchConfig
93 //! Work groups (CUDA blocks) counts
94 size_t gridSize[3] = { 1, 1, 1 };
95 //! Per work group (CUDA block) thread counts
96 size_t blockSize[3] = { 1, 1, 1 };
97 //! Shared memory size in bytes
98 size_t sharedMemorySize = 0;
101 /*! \brief Sets whether device code can use arrays that are embedded in structs.
102 * Note that OpenCL 2.x might be able to do this, but we use 1.2.
104 #define c_canEmbedBuffers false