src/gromacs/gpu_utils/gputraits_ocl.h

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