src/gromacs/gpu_utils/cuda_arch_utils.cuh

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2014,2015,2016,2017, 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 CUDA_ARCH_UTILS_CUH_
  36 #define CUDA_ARCH_UTILS_CUH_
  37
  38 #include "config.h"
  39
  40 #include "gromacs/utility/basedefinitions.h"
  41
  42 /*! \file
  43  *  \brief CUDA arch dependent definitions.
  44  *
  45  *  \author Szilard Pall <pall.szilard@gmail.com>
  46  */
  47
  48 /* GMX_PTX_ARCH is set to the virtual arch (PTX) version targeted by
  49  * the current compiler pass or zero for the host pass and it is
  50  * intended to be used instead of __CUDA_ARCH__.
  51  */
  52 #ifndef __CUDA_ARCH__
  53     #define GMX_PTX_ARCH 0
  54 #else
  55     #define GMX_PTX_ARCH __CUDA_ARCH__
  56 #endif
  57
  58 /* Until CC 5.2 and likely for the near future all NVIDIA architectures
  59    have a warp size of 32, but this could change later. If it does, the
  60    following constants should depend on the value of GMX_PTX_ARCH.
  61  */
  62 static const int warp_size      = 32;
  63 static const int warp_size_log2 = 5;
  64 /*! \brief Bitmask corresponding to all threads active in a warp.
  65  *  NOTE that here too we assume 32-wide warps.
  66  */
  67 static const unsigned int c_fullWarpMask = 0xffffffff;
  68
  69 /* Below are backward-compatibility wrappers for CUDA 9 warp-wide intrinsics. */
  70
  71 /*! \brief Compatibility wrapper around the CUDA __syncwarp() instrinsic.  */
  72 static __forceinline__ __device__
  73 void gmx_syncwarp(const unsigned int activeMask = c_fullWarpMask)
  74 {
  75 #if GMX_CUDA_VERSION < 9000
  76     /* no sync needed on pre-Volta. */
  77     GMX_UNUSED_VALUE(activeMask);
  78 #else
  79     __syncwarp(activeMask);
  80 #endif
  81 }
  82
  83 /*! \brief Compatibility wrapper around the CUDA __ballot()/__ballot_sync() instrinsic.  */
  84 static __forceinline__ __device__
  85 unsigned int gmx_ballot_sync(const unsigned int activeMask,
  86                              const int          pred)
  87 {
  88 #if GMX_CUDA_VERSION < 9000
  89     GMX_UNUSED_VALUE(activeMask);
  90     return __ballot(pred);
  91 #else
  92     return __ballot_sync(activeMask, pred);
  93 #endif
  94 }
  95
  96 /*! \brief Compatibility wrapper around the CUDA __any()/__any_sync() instrinsic.  */
  97 static __forceinline__ __device__
  98 int gmx_any_sync(const unsigned int activeMask,
  99                  const int          pred)
 100 {
 101 #if GMX_CUDA_VERSION < 9000
 102     GMX_UNUSED_VALUE(activeMask);
 103     return __any(pred);
 104 #else
 105     return __any_sync(activeMask, pred);
 106 #endif
 107 }
 108
 109 /*! \brief Compatibility wrapper around the CUDA __shfl_up()/__shfl_up_sync() instrinsic.  */
 110 template <typename T>
 111 static __forceinline__ __device__
 112 T gmx_shfl_up_sync(const unsigned int activeMask,
 113                    const T            var,
 114                    unsigned int       offset,
 115                    int                width = warp_size)
 116 {
 117 #if GMX_CUDA_VERSION < 9000
 118     GMX_UNUSED_VALUE(activeMask);
 119     return __shfl_up(var, offset, width);
 120 #else
 121     return __shfl_up_sync(activeMask, var, offset, width);
 122 #endif
 123 }
 124
 125 /*! \brief Compatibility wrapper around the CUDA __shfl_down()/__shfl_down_sync() instrinsic.  */
 126 template <typename T>
 127 static __forceinline__ __device__
 128 T gmx_shfl_down_sync(const unsigned int activeMask,
 129                      const T            var,
 130                      unsigned int       offset,
 131                      int                width = warp_size)
 132 {
 133 #if GMX_CUDA_VERSION < 9000
 134     GMX_UNUSED_VALUE(activeMask);
 135     return __shfl_down(var, offset, width);
 136 #else
 137     return __shfl_down_sync(activeMask, var, offset, width);
 138 #endif
 139 }
 140
 141 /*! \brief Allow disabling CUDA textures using the GMX_DISABLE_CUDA_TEXTURES macro.
 142  *
 143  *  This option will not influence functionality. All features using textures ought
 144  *  to have fallback for texture-less reads (direct/LDG loads), all new code needs
 145  *  to provide fallback code.
 146  */
 147 #if defined GMX_DISABLE_CUDA_TEXTURES
 148 #define DISABLE_CUDA_TEXTURES 1
 149 #else
 150 #define DISABLE_CUDA_TEXTURES 0
 151 #endif
 152
 153 /*! \brief True if the use of texture fetch in the CUDA kernels is disabled. */
 154 static const bool c_disableCudaTextures = DISABLE_CUDA_TEXTURES;
 155
 156
 157 /* CUDA architecture technical characteristics. Needs macros because it is used
 158  * in the __launch_bounds__ function qualifiers and might need it in preprocessor
 159  * conditionals.
 160  *
 161  */
 162 #if GMX_PTX_ARCH > 0
 163     #if   GMX_PTX_ARCH <= 210  // CC 2.x
 164         #define GMX_CUDA_MAX_BLOCKS_PER_MP   8
 165         #define GMX_CUDA_MAX_THREADS_PER_MP  1536
 166     #elif GMX_PTX_ARCH <= 370  // CC 3.x
 167         #define GMX_CUDA_MAX_BLOCKS_PER_MP   16
 168         #define GMX_CUDA_MAX_THREADS_PER_MP  2048
 169     #else // CC 5.x, 6.x
 170           /* Note that this final branch covers all future architectures (current gen
 171            * is 6.x as of writing), hence assuming that these *currently defined* upper
 172            * limits will not be lowered.
 173            */
 174         #define GMX_CUDA_MAX_BLOCKS_PER_MP   32
 175         #define GMX_CUDA_MAX_THREADS_PER_MP  2048
 176     #endif
 177 #else
 178         #define GMX_CUDA_MAX_BLOCKS_PER_MP   0
 179         #define GMX_CUDA_MAX_THREADS_PER_MP  0
 180 #endif
 181
 182 #endif /* CUDA_ARCH_UTILS_CUH_ */