src/gromacs/ewald/pme_gpu_constants.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 /*! \internal \file
  36  * \brief This file defines the PME GPU compile-time constants/macros,
  37  * used both in device and host code.
  38  *
  39  * As OpenCL C is not aware of constexpr, most of this file is
  40  * forwarded to the OpenCL kernel compilation as defines with same
  41  * names, for the sake of code similarity.
  42  *
  43  * \todo The values are currently common to both CUDA and OpenCL
  44  * implementations, but should be reconsidered when we tune the OpenCL
  45  * implementation. See Redmine #2528.
  46  *
  47  * \author Aleksei Iupinov <a.yupinov@gmail.com>
  48  * \ingroup module_ewald
  49  */
  50
  51 #ifndef GMX_EWALD_PME_GPU_CONSTANTS_H
  52 #define GMX_EWALD_PME_GPU_CONSTANTS_H
  53
  54 #include "config.h"
  55
  56 #if GMX_GPU == GMX_GPU_CUDA
  57 #    include "gromacs/gpu_utils/cuda_arch_utils.cuh" // for warp_size
  58 #endif
  59
  60 /* General settings for PME GPU behaviour */
  61
  62 /*! \brief
  63  * false: Atoms with zero charges are processed by PME. Could introduce some overhead.
  64  * true:  Atoms with zero charges are not processed by PME. Adds branching to the spread/gather.
  65  *        Could be good for performance in specific systems with lots of neutral atoms.
  66  * \todo Estimate performance differences.
  67  */
  68 constexpr bool c_skipNeutralAtoms = false;
  69
  70 /*! \brief
  71  * Number of PME solve output floating point numbers.
  72  * 6 for symmetric virial matrix + 1 for reciprocal energy.
  73  */
  74 constexpr int c_virialAndEnergyCount = 7;
  75
  76
  77 /* Macros concerning the data layout */
  78
  79 /*
  80     Here is a current memory layout for the theta/dtheta B-spline float parameter arrays.
  81     This is the data in global memory used both by spreading and gathering kernels (with same scheduling).
  82     This example has PME order 4 and 2 particles per warp/data chunk.
  83     Each particle has 16 threads assigned to it, each thread works on 4 non-sequential global grid contributions.
  84
  85     ----------------------------------------------------------------------------
  86     particles 0, 1                                        | particles 2, 3     | ...
  87     ----------------------------------------------------------------------------
  88     order index 0           | index 1 | index 2 | index 3 | order index 0 .....
  89     ----------------------------------------------------------------------------
  90     tx0 tx1 ty0 ty1 tz0 tz1 | ..........
  91     ----------------------------------------------------------------------------
  92
  93     Each data chunk for a single warp is 24 floats. This goes both for theta and dtheta.
  94     24 = 2 particles per warp * order 4 * 3 dimensions. 48 floats (1.5 warp size) per warp in total.
  95     I have also tried intertwining theta and theta in a single array (they are used in pairs in gathering stage anyway)
  96     and it didn't seem to make a performance difference.
  97
  98     The spline indexing is isolated in the 2 inline functions:
  99     getSplineParamIndexBase() return a base shared memory index corresponding to the atom in the block;
 100     getSplineParamIndex() consumes its results and adds offsets for dimension and spline value index.
 101
 102     The corresponding defines follow.
 103  */
 104
 105 /*! \brief PME order parameter
 106  *
 107  *  Note that the GPU code, unlike the CPU, only supports order 4.
 108  */
 109 constexpr int c_pmeGpuOrder = 4;
 110
 111 /*! \brief
 112  * The number of GPU threads used for computing spread/gather contributions of a single atom as function of the PME order.
 113  * The assumption is currently that any thread processes only a single atom's contributions.
 114  * TODO: this assumption leads to minimum execution width of 16. See Redmine #2516
 115  */
 116 constexpr int c_pmeSpreadGatherThreadsPerAtom = c_pmeGpuOrder * c_pmeGpuOrder;
 117
 118 //! Number of threads per atom when order threads are used
 119 constexpr int c_pmeSpreadGatherThreadsPerAtom4ThPerAtom = c_pmeGpuOrder;
 120
 121 /*! \brief Minimum execution width of the PME spread and gather kernels.
 122  *
 123  * Due to the one thread per atom and order=4 implementation constraints, order^2 threads
 124  * should execute without synchronization needed. See c_pmeSpreadGatherThreadsPerAtom
 125  */
 126 constexpr int c_pmeSpreadGatherMinWarpSize = c_pmeSpreadGatherThreadsPerAtom;
 127
 128 //! Minimum warp size if order threads pera atom are used instead of order^2
 129 constexpr int c_pmeSpreadGatherMinWarpSize4ThPerAtom = c_pmeSpreadGatherThreadsPerAtom4ThPerAtom;
 130
 131 /*! \brief
 132  * Atom data alignment (in terms of number of atoms).
 133  * This is the least common multiple of number of atoms processed by
 134  * a single block/workgroup of the spread and gather kernels.
 135  * The GPU atom data buffers must be padded, which means that
 136  * the numbers of atoms used for determining the size of the memory
 137  * allocation must be divisible by this.
 138  */
 139 constexpr int c_pmeAtomDataBlockSize = 64;
 140
 141 /*
 142  * The execution widths for PME GPU kernels, used both on host and device for correct scheduling.
 143  * TODO: those were tuned for CUDA with assumption of warp size 32; specialize those for OpenCL
 144  * (Redmine #2528).
 145  * As noted below, these are very approximate maximum sizes; in run time we might have to use
 146  * smaller block/workgroup sizes, depending on device capabilities.
 147  */
 148
 149 //! Spreading max block width in warps picked among powers of 2 (2, 4, 8, 16) for max. occupancy and min. runtime in most cases
 150 constexpr int c_spreadMaxWarpsPerBlock = 8;
 151
 152 //! Solving kernel max block width in warps picked among powers of 2 (2, 4, 8, 16) for max.
 153 //! occupancy and min. runtime (560Ti (CC2.1), 660Ti (CC3.0) and 750 (CC5.0)))
 154 constexpr int c_solveMaxWarpsPerBlock = 8;
 155
 156 //! Gathering max block width in warps - picked empirically among 2, 4, 8, 16 for max. occupancy and min. runtime
 157 constexpr int c_gatherMaxWarpsPerBlock = 4;
 158
 159
 160 #if GMX_GPU == GMX_GPU_CUDA
 161
 162 /* All the guys below are dependent on warp_size and should ideally be removed from the host-side code,
 163  * as we have to do that for OpenCL already.
 164  * They also express maximum desired block/workgroup sizes, while both with CUDA and OpenCL we have to treat
 165  * the device runtime limitations gracefully as well.
 166  */
 167
 168 /*! \brief
 169  * The number of atoms processed by a single warp in spread/gather.
 170  * This macro depends on the templated order parameter (2 atoms per warp for order 4 and warp_size
 171  * of 32). It is mostly used for spline data layout tweaked for coalesced access.
 172  */
 173 constexpr int c_pmeSpreadGatherAtomsPerWarp = (warp_size / c_pmeSpreadGatherThreadsPerAtom);
 174
 175 //! number of atoms per warp when order threads are used per atom
 176 constexpr int c_pmeSpreadGatherAtomsPerWarp4ThPerAtom =
 177         (warp_size / c_pmeSpreadGatherThreadsPerAtom4ThPerAtom);
 178
 179 //! Spreading max block size in threads
 180 constexpr int c_spreadMaxThreadsPerBlock = c_spreadMaxWarpsPerBlock * warp_size;
 181
 182 //! Solving kernel max block size in threads
 183 constexpr int c_solveMaxThreadsPerBlock = (c_solveMaxWarpsPerBlock * warp_size);
 184
 185 //! Gathering max block size in threads
 186 constexpr int c_gatherMaxThreadsPerBlock = c_gatherMaxWarpsPerBlock * warp_size;
 187 //! Gathering min blocks per CUDA multiprocessor
 188 constexpr int c_gatherMinBlocksPerMP = GMX_CUDA_MAX_THREADS_PER_MP / c_gatherMaxThreadsPerBlock;
 189
 190 #endif // GMX_GPU == GMX_GPU_CUDA
 191
 192 #endif