src/gromacs/gpu_utils/gputraits.cuh

   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_CUH
  36 #define GMX_GPU_UTILS_GPUTRAITS_CUH
  37
  38 /*! \libinternal \file
  39  *  \brief Declares the CUDA type traits.
  40  *  \author Aleksei Iupinov <a.yupinov@gmail.com>
  41  *
  42  * \inlibraryapi
  43  * \ingroup module_gpu_utils
  44  */
  45
  46 /*! \brief CUDA device information.
  47  *
  48  * The CUDA device information is queried and set at detection and contains
  49  * both information about the device/hardware returned by the runtime as well
  50  * as additional data like support status.
  51  */
  52 struct DeviceInformation
  53 {
  54     //! ID of the CUDA device.
  55     int id;
  56     //! CUDA device properties.
  57     cudaDeviceProp prop;
  58     //! Result of the device check.
  59     int stat;
  60 };
  61
  62 //! \brief GPU command stream
  63 using CommandStream = cudaStream_t;
  64 //! \brief Single GPU call timing event - meaningless in CUDA
  65 using CommandEvent = void;
  66 //! \brief Context used explicitly in OpenCL, does nothing in CUDA
  67 using DeviceContext = void*;
  68
  69 /*! \internal \brief
  70  * GPU kernels scheduling description. This is same in OpenCL/CUDA.
  71  * Provides reasonable defaults, one typically only needs to set the GPU stream
  72  * and non-1 work sizes.
  73  */
  74 struct KernelLaunchConfig
  75 {
  76     size_t        gridSize[3]      = { 1, 1, 1 }; //!< Block counts
  77     size_t        blockSize[3]     = { 1, 1, 1 }; //!< Per-block thread counts
  78     size_t        sharedMemorySize = 0;           //!< Shared memory size in bytes
  79     CommandStream stream           = nullptr;     //!< Stream to launch kernel in
  80 };
  81
  82 //! Sets whether device code can use arrays that are embedded in structs.
  83 #define c_canEmbedBuffers true
  84 // TODO this should be constexpr bool
  85
  86 #endif