src/gromacs/nbnxm/opencl/nbnxm_ocl_types.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2016 by the GROMACS development team.
   5  * Copyright (c) 2017,2018,2019,2020,2021, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36
  37 /*! \internal \file
  38  *  \brief
  39  *  Data types used internally in the nbnxm_ocl module.
  40  *
  41  *  \author Anca Hamuraru <anca@streamcomputing.eu>
  42  *  \author Szilárd Páll <pszilard@kth.se>
  43  *  \ingroup module_nbnxm
  44  */
  45
  46 #ifndef GMX_NBNXM_NBNXM_OPENCL_TYPES_H
  47 #define GMX_NBNXM_NBNXM_OPENCL_TYPES_H
  48
  49 #include "gromacs/gpu_utils/devicebuffer.h"
  50 #include "gromacs/gpu_utils/gmxopencl.h"
  51 #include "gromacs/gpu_utils/gpueventsynchronizer_ocl.h"
  52 #include "gromacs/gpu_utils/gputraits_ocl.h"
  53 #include "gromacs/gpu_utils/oclutils.h"
  54 #include "gromacs/mdtypes/interaction_const.h"
  55 #include "gromacs/nbnxm/gpu_types_common.h"
  56 #include "gromacs/nbnxm/nbnxm.h"
  57 #include "gromacs/nbnxm/nbnxm_gpu.h"
  58 #include "gromacs/nbnxm/pairlist.h"
  59 #include "gromacs/utility/enumerationhelpers.h"
  60 #include "gromacs/utility/fatalerror.h"
  61 #include "gromacs/utility/real.h"
  62
  63 #include "nbnxm_ocl_consts.h"
  64
  65 struct gmx_wallclock_gpu_nbnxn_t;
  66
  67 /* kernel does #include "gromacs/math/utilities.h" */
  68 /* Move the actual useful stuff here: */
  69
  70 //! Define 1/sqrt(pi)
  71 #define M_FLOAT_1_SQRTPI 0.564189583547756f
  72
  73 /*! \brief Constants for platform-dependent defaults for the prune kernel's j4 processing concurrency.
  74  *
  75  *  Initialized using macros that can be overridden at compile-time (using #GMX_NBNXN_PRUNE_KERNEL_J4_CONCURRENCY).
  76  */
  77 /*! @{ */
  78 const int c_oclPruneKernelJ4ConcurrencyDEFAULT = GMX_NBNXN_PRUNE_KERNEL_J4_CONCURRENCY_DEFAULT;
  79 /*! @} */
  80
  81 /*! \brief Pruning kernel flavors.
  82  *
  83  * The values correspond to the first call of the pruning post-list generation
  84  * and the rolling pruning, respectively.
  85  */
  86 enum ePruneKind
  87 {
  88     epruneFirst,
  89     epruneRolling,
  90     ePruneNR
  91 };
  92
  93 /*! \internal
  94  * \brief Staging area for temporary data downloaded from the GPU.
  95  *
  96  *  The energies/shift forces get downloaded here first, before getting added
  97  *  to the CPU-side aggregate values.
  98  */
  99 struct nb_staging_t
 100 {
 101     //! LJ energy
 102     float* e_lj = nullptr;
 103     //! electrostatic energy
 104     float* e_el = nullptr;
 105     //! float3 buffer with shift forces
 106     float (*fshift)[3] = nullptr;
 107 };
 108
 109 /*! \internal
 110  * \brief Nonbonded atom data - both inputs and outputs.
 111  */
 112 typedef struct cl_atomdata
 113 {
 114     //! number of atoms
 115     int natoms;
 116     //! number of local atoms
 117     int natoms_local;
 118     //! allocation size for the atom data (xq, f)
 119     int nalloc;
 120
 121     //! float4 buffer with atom coordinates + charges, size natoms
 122     DeviceBuffer<float> xq;
 123
 124     //! float3 buffer with force output array, size natoms
 125     DeviceBuffer<float> f;
 126
 127     //! LJ energy output, size 1
 128     DeviceBuffer<float> e_lj;
 129     //! Electrostatics energy input, size 1
 130     DeviceBuffer<float> e_el;
 131
 132     //! float3 buffer with shift forces
 133     DeviceBuffer<float> fshift;
 134
 135     //! number of atom types
 136     int ntypes;
 137     //! int buffer with atom type indices, size natoms
 138     DeviceBuffer<int> atom_types;
 139     //! float2 buffer with sqrt(c6),sqrt(c12), size natoms
 140     DeviceBuffer<float> lj_comb;
 141
 142     //! float3 buffer with shifts values
 143     DeviceBuffer<float> shift_vec;
 144
 145     //! true if the shift vector has been uploaded
 146     bool bShiftVecUploaded;
 147 } cl_atomdata_t;
 148
 149 /*! \internal
 150  * \brief Data structure shared between the OpenCL device code and OpenCL host code
 151  *
 152  * Must not contain OpenCL objects (buffers)
 153  * TODO: review, improve */
 154 typedef struct cl_nbparam_params
 155 {
 156
 157     //! type of electrostatics
 158     enum Nbnxm::ElecType elecType;
 159     //! type of VdW impl.
 160     enum Nbnxm::VdwType vdwType;
 161
 162     //! charge multiplication factor
 163     float epsfac;
 164     //! Reaction-field/plain cutoff electrostatics const.
 165     float c_rf;
 166     //! Reaction-field electrostatics constant
 167     float two_k_rf;
 168     //! Ewald/PME parameter
 169     float ewald_beta;
 170     //! Ewald/PME correction term subtracted from the direct-space potential
 171     float sh_ewald;
 172     //! LJ-Ewald/PME correction term added to the correction potential
 173     float sh_lj_ewald;
 174     //! LJ-Ewald/PME coefficient
 175     float ewaldcoeff_lj;
 176
 177     //! Coulomb cut-off squared
 178     float rcoulomb_sq;
 179
 180     //! VdW cut-off squared
 181     float rvdw_sq;
 182     //! VdW switched cut-off
 183     float rvdw_switch;
 184     //! Full, outer pair-list cut-off squared
 185     float rlistOuter_sq;
 186     //! Inner, dynamic pruned pair-list cut-off squared
 187     float rlistInner_sq;
 188
 189     //! VdW shift dispersion constants
 190     shift_consts_t dispersion_shift;
 191     //! VdW shift repulsion constants
 192     shift_consts_t repulsion_shift;
 193     //! VdW switch constants
 194     switch_consts_t vdw_switch;
 195
 196     /* Ewald Coulomb force table data - accessed through texture memory */
 197     //! table scale/spacing
 198     float coulomb_tab_scale;
 199 } cl_nbparam_params_t;
 200
 201
 202 /** \internal
 203  * \brief Typedef of actual timer type.
 204  */
 205 typedef struct Nbnxm::gpu_timers_t cl_timers_t;
 206
 207 /*! \internal
 208  * \brief Main data structure for OpenCL nonbonded force calculations.
 209  */
 210 struct NbnxmGpu
 211 {
 212     /* \brief OpenCL device context
 213      *
 214      * \todo Make it constant reference, once NbnxmGpu is a proper class.
 215      */
 216     const DeviceContext* deviceContext_;
 217     //! OpenCL runtime data (context, kernels)
 218     struct gmx_device_runtime_data_t* dev_rundata = nullptr;
 219
 220     /**< Pointers to non-bonded kernel functions
 221      * organized similar with nb_kfunc_xxx arrays in nbnxn_ocl.cpp */
 222     ///@{
 223     cl_kernel kernel_noener_noprune_ptr[Nbnxm::c_numElecTypes][Nbnxm::c_numVdwTypes] = { { nullptr } };
 224     cl_kernel kernel_ener_noprune_ptr[Nbnxm::c_numElecTypes][Nbnxm::c_numVdwTypes] = { { nullptr } };
 225     cl_kernel kernel_noener_prune_ptr[Nbnxm::c_numElecTypes][Nbnxm::c_numVdwTypes] = { { nullptr } };
 226     cl_kernel kernel_ener_prune_ptr[Nbnxm::c_numElecTypes][Nbnxm::c_numVdwTypes] = { { nullptr } };
 227     ///@}
 228     //! prune kernels, ePruneKind defined the kernel kinds
 229     cl_kernel kernel_pruneonly[ePruneNR] = { nullptr };
 230
 231     //! true if prefetching fg i-atom LJ parameters should be used in the kernels
 232     bool bPrefetchLjParam = false;
 233
 234     /**< auxiliary kernels implementing memset-like functions */
 235     ///@{
 236     cl_kernel kernel_memset_f      = nullptr;
 237     cl_kernel kernel_memset_f2     = nullptr;
 238     cl_kernel kernel_memset_f3     = nullptr;
 239     cl_kernel kernel_zero_e_fshift = nullptr;
 240     ///@}
 241
 242     //! true if doing both local/non-local NB work on GPU
 243     bool bUseTwoStreams = false;
 244     //! true indicates that the nonlocal_done event was marked
 245     bool bNonLocalStreamDoneMarked = false;
 246
 247     //! atom data
 248     cl_atomdata_t* atdat = nullptr;
 249     //! parameters required for the non-bonded calc.
 250     NBParamGpu* nbparam = nullptr;
 251     //! pair-list data structures (local and non-local)
 252     gmx::EnumerationArray<Nbnxm::InteractionLocality, Nbnxm::gpu_plist*> plist = { nullptr };
 253     //! staging area where fshift/energies get downloaded
 254     nb_staging_t nbst;
 255
 256     //! local and non-local GPU queues
 257     gmx::EnumerationArray<Nbnxm::InteractionLocality, const DeviceStream*> deviceStreams;
 258
 259     /*! \brief Events used for synchronization */
 260     /*! \{ */
 261     /*! \brief Event triggered when the non-local non-bonded
 262      * kernel is done (and the local transfer can proceed) */
 263     GpuEventSynchronizer nonlocal_done;
 264     /*! \brief Event triggered when the tasks issued in the local
 265      * stream that need to precede the non-local force or buffer
 266      * operation calculations are done (e.g. f buffer 0-ing, local
 267      * x/q H2D, buffer op initialization in local stream that is
 268      * required also by nonlocal stream ) */
 269     GpuEventSynchronizer misc_ops_and_local_H2D_done;
 270     /*! \} */
 271
 272     //! True if there has been local/nonlocal GPU work, either bonded or nonbonded, scheduled
 273     //  to be executed in the current domain. As long as bonded work is not split up into
 274     //  local/nonlocal, if there is bonded GPU work, both flags will be true.
 275     gmx::EnumerationArray<Nbnxm::InteractionLocality, bool> haveWork;
 276
 277
 278     //! True if event-based timing is enabled.
 279     bool bDoTime = false;
 280     //! OpenCL event-based timers.
 281     cl_timers_t* timers = nullptr;
 282     //! Timing data. TODO: deprecate this and query timers for accumulated data instead
 283     gmx_wallclock_gpu_nbnxn_t* timings = nullptr;
 284 };
 285
 286 #endif /* NBNXN_OPENCL_TYPES_H */