src/gromacs/gpu_utils/cuda_kernel_utils.cuh

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2017,2018,2019,2021, 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_CUDA_KERNEL_UTILS_CUH
  36 #define GMX_GPU_UTILS_CUDA_KERNEL_UTILS_CUH
  37
  38 /*! \file
  39  *  \brief CUDA device util functions (callable from GPU kernels).
  40  *
  41  *  \author Szilard Pall <pall.szilard@gmail.com>
  42  */
  43
  44 #include "gromacs/gpu_utils/cuda_arch_utils.cuh"
  45
  46 /*! Load directly or using __ldg() when supported. */
  47 template<typename T>
  48 __device__ __forceinline__ T LDG(const T* ptr)
  49 {
  50 #if GMX_PTX_ARCH >= 350
  51     /* CC >=3.5 supports constant loads through texture or L1 */
  52     return __ldg(ptr);
  53 #else
  54     /* Device does not have LDG support, fall back to direct load. */
  55     return *ptr;
  56 #endif
  57 }
  58
  59 /*! \brief Fetch the value by \p index from the texture object.
  60  *
  61  * \tparam T            Raw data type
  62  * \param[in] texObj    Table texture object
  63  * \param[in] index     Non-negative element index
  64  * \returns             The value from the table at \p index
  65  */
  66 template<typename T>
  67 static __forceinline__ __device__ T fetchFromTexture(const cudaTextureObject_t texObj, int index)
  68 {
  69     assert(index >= 0);
  70     // NOLINTNEXTLINE(misc-static-assert)
  71     assert(!c_disableCudaTextures);
  72     return tex1Dfetch<T>(texObj, index);
  73 }
  74
  75 /*! \brief Fetch the value by \p index from the parameter lookup table.
  76  *
  77  *  Depending on what is supported, it fetches parameters either
  78  *  using direct load or texture objects.
  79  *
  80  * \tparam T            Raw data type
  81  * \param[in] d_ptr     Device pointer to the raw table memory
  82  * \param[in] texObj    Table texture object
  83  * \param[in] index     Non-negative element index
  84  * \returns             The value from the table at \p index
  85  */
  86 template<typename T>
  87 static __forceinline__ __device__ T fetchFromParamLookupTable(const T*                  d_ptr,
  88                                                               const cudaTextureObject_t texObj,
  89                                                               int                       index)
  90 {
  91     assert(index >= 0);
  92     T result;
  93 #if DISABLE_CUDA_TEXTURES
  94     GMX_UNUSED_VALUE(texObj);
  95     result = LDG(d_ptr + index);
  96 #else
  97     GMX_UNUSED_VALUE(d_ptr);
  98     result = fetchFromTexture<T>(texObj, index);
  99 #endif
 100     return result;
 101 }
 102
 103
 104 #endif /* GMX_GPU_UTILS_CUDA_KERNEL_UTILS_CUH */