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, 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/gputraits_ocl.h"
  52 #include "gromacs/gpu_utils/oclutils.h"
  53 #include "gromacs/mdtypes/interaction_const.h"
  54 #include "gromacs/nbnxm/gpu_types_common.h"
  55 #include "gromacs/nbnxm/nbnxm.h"
  56 #include "gromacs/nbnxm/pairlist.h"
  57 #include "gromacs/utility/enumerationhelpers.h"
  58 #include "gromacs/utility/fatalerror.h"
  59 #include "gromacs/utility/real.h"
  60
  61 #include "nbnxm_ocl_consts.h"
  62
  63 struct gmx_wallclock_gpu_nbnxn_t;
  64
  65 /* kernel does #include "gromacs/math/utilities.h" */
  66 /* Move the actual useful stuff here: */
  67
  68 //! Define 1/sqrt(pi)
  69 #define M_FLOAT_1_SQRTPI 0.564189583547756f
  70
  71 /*! @} */
  72 /*! \brief Constants for platform-dependent defaults for the prune kernel's j4 processing concurrency.
  73  *
  74  *  Initialized using macros that can be overridden at compile-time (using #GMX_NBNXN_PRUNE_KERNEL_J4_CONCURRENCY).
  75  */
  76 /*! @{ */
  77 const int c_oclPruneKernelJ4ConcurrencyDEFAULT = GMX_NBNXN_PRUNE_KERNEL_J4_CONCURRENCY_DEFAULT;
  78 /*! @} */
  79
  80 /*! \brief Returns the j4 processing concurrency parameter for the vendor \p vendorId
  81  *  \param deviceVendor Vendor.
  82  */
  83 static inline int getOclPruneKernelJ4Concurrency(DeviceVendor deviceVendor)
  84 {
  85     switch (deviceVendor)
  86     {
  87         default: return c_oclPruneKernelJ4ConcurrencyDEFAULT;
  88     }
  89 }
  90
  91 /*! \brief Electrostatic OpenCL kernel flavors.
  92  *
  93  *  Types of electrostatics implementations available in the OpenCL non-bonded
  94  *  force kernels. These represent both the electrostatics types implemented
  95  *  by the kernels (cut-off, RF, and Ewald - a subset of what's defined in
  96  *  enums.h) as well as encode implementation details analytical/tabulated
  97  *  and single or twin cut-off (for Ewald kernels).
  98  *  Note that the cut-off and RF kernels have only analytical flavor and unlike
  99  *  in the CPU kernels, the tabulated kernels are ATM Ewald-only.
 100  *
 101  *  The row-order of pointers to different electrostatic kernels defined in
 102  *  nbnxn_cuda.cu by the nb_*_kfunc_ptr function pointer table
 103  *  should match the order of enumerated types below.
 104  */
 105 enum eelOcl
 106 {
 107     eelOclCUT,
 108     eelOclRF,
 109     eelOclEWALD_TAB,
 110     eelOclEWALD_TAB_TWIN,
 111     eelOclEWALD_ANA,
 112     eelOclEWALD_ANA_TWIN,
 113     eelOclNR
 114 };
 115
 116 /*! \brief VdW OpenCL kernel flavors.
 117  *
 118  * The enumerates values correspond to the LJ implementations in the OpenCL non-bonded
 119  * kernels.
 120  *
 121  * The column-order of pointers to different electrostatic kernels defined in
 122  * nbnxn_cuda.cu by the nb_*_kfunc_ptr function pointer table
 123  * should match the order of enumerated types below.
 124  */
 125 enum evdwOcl
 126 {
 127     evdwOclCUT,
 128     evdwOclCUTCOMBGEOM,
 129     evdwOclCUTCOMBLB,
 130     evdwOclFSWITCH,
 131     evdwOclPSWITCH,
 132     evdwOclEWALDGEOM,
 133     evdwOclEWALDLB,
 134     evdwOclNR
 135 };
 136
 137 /*! \brief Pruning kernel flavors.
 138  *
 139  * The values correspond to the first call of the pruning post-list generation
 140  * and the rolling pruning, respectively.
 141  */
 142 enum ePruneKind
 143 {
 144     epruneFirst,
 145     epruneRolling,
 146     ePruneNR
 147 };
 148
 149 /*! \internal
 150  * \brief Staging area for temporary data downloaded from the GPU.
 151  *
 152  *  The energies/shift forces get downloaded here first, before getting added
 153  *  to the CPU-side aggregate values.
 154  */
 155 struct nb_staging_t
 156 {
 157     //! LJ energy
 158     float* e_lj = nullptr;
 159     //! electrostatic energy
 160     float* e_el = nullptr;
 161     //! float3 buffer with shift forces
 162     float (*fshift)[3] = nullptr;
 163 };
 164
 165 /*! \internal
 166  * \brief Nonbonded atom data - both inputs and outputs.
 167  */
 168 typedef struct cl_atomdata
 169 {
 170     //! number of atoms
 171     int natoms;
 172     //! number of local atoms
 173     int natoms_local;
 174     //! allocation size for the atom data (xq, f)
 175     int nalloc;
 176
 177     //! float4 buffer with atom coordinates + charges, size natoms
 178     cl_mem xq;
 179
 180     //! float3 buffer with force output array, size natoms
 181     cl_mem f;
 182
 183     //! LJ energy output, size 1
 184     cl_mem e_lj;
 185     //! Electrostatics energy input, size 1
 186     cl_mem e_el;
 187
 188     //! float3 buffer with shift forces
 189     cl_mem fshift;
 190
 191     //! number of atom types
 192     int ntypes;
 193     //! int buffer with atom type indices, size natoms
 194     cl_mem atom_types;
 195     //! float2 buffer with sqrt(c6),sqrt(c12), size natoms
 196     cl_mem lj_comb;
 197
 198     //! float3 buffer with shifts values
 199     cl_mem shift_vec;
 200
 201     //! true if the shift vector has been uploaded
 202     bool bShiftVecUploaded;
 203 } cl_atomdata_t;
 204
 205 /*! \internal
 206  * \brief Parameters required for the OpenCL nonbonded calculations.
 207  */
 208 typedef struct cl_nbparam
 209 {
 210
 211     //! type of electrostatics, takes values from #eelOcl
 212     int eeltype;
 213     //! type of VdW impl., takes values from #evdwOcl
 214     int vdwtype;
 215
 216     //! charge multiplication factor
 217     float epsfac;
 218     //! Reaction-field/plain cutoff electrostatics const.
 219     float c_rf;
 220     //! Reaction-field electrostatics constant
 221     float two_k_rf;
 222     //! Ewald/PME parameter
 223     float ewald_beta;
 224     //! Ewald/PME correction term substracted from the direct-space potential
 225     float sh_ewald;
 226     //! LJ-Ewald/PME correction term added to the correction potential
 227     float sh_lj_ewald;
 228     //! LJ-Ewald/PME coefficient
 229     float ewaldcoeff_lj;
 230
 231     //! Coulomb cut-off squared
 232     float rcoulomb_sq;
 233
 234     //! VdW cut-off squared
 235     float rvdw_sq;
 236     //! VdW switched cut-off
 237     float rvdw_switch;
 238     //! Full, outer pair-list cut-off squared
 239     float rlistOuter_sq;
 240     //! Inner, dynamic pruned pair-list cut-off squared
 241     float rlistInner_sq;
 242     //! True if we use dynamic pair-list pruning
 243     bool useDynamicPruning;
 244
 245     //! VdW shift dispersion constants
 246     shift_consts_t dispersion_shift;
 247     //! VdW shift repulsion constants
 248     shift_consts_t repulsion_shift;
 249     //! VdW switch constants
 250     switch_consts_t vdw_switch;
 251
 252     /* LJ non-bonded parameters - accessed through texture memory */
 253     //! nonbonded parameter table with C6/C12 pairs per atom type-pair, 2*ntype^2 elements
 254     cl_mem nbfp_climg2d;
 255     //! nonbonded parameter table per atom type, 2*ntype elements
 256     cl_mem nbfp_comb_climg2d;
 257
 258     /* Ewald Coulomb force table data - accessed through texture memory */
 259     //! table scale/spacing
 260     float coulomb_tab_scale;
 261     //! pointer to the table in the device memory
 262     cl_mem coulomb_tab_climg2d;
 263 } cl_nbparam_t;
 264
 265 /*! \internal
 266  * \brief Data structure shared between the OpenCL device code and OpenCL host code
 267  *
 268  * Must not contain OpenCL objects (buffers)
 269  * TODO: review, improve */
 270 typedef struct cl_nbparam_params
 271 {
 272
 273     //! type of electrostatics, takes values from #eelCu
 274     int eeltype;
 275     //! type of VdW impl., takes values from #evdwCu
 276     int vdwtype;
 277
 278     //! charge multiplication factor
 279     float epsfac;
 280     //! Reaction-field/plain cutoff electrostatics const.
 281     float c_rf;
 282     //! Reaction-field electrostatics constant
 283     float two_k_rf;
 284     //! Ewald/PME parameter
 285     float ewald_beta;
 286     //! Ewald/PME correction term substracted from the direct-space potential
 287     float sh_ewald;
 288     //! LJ-Ewald/PME correction term added to the correction potential
 289     float sh_lj_ewald;
 290     //! LJ-Ewald/PME coefficient
 291     float ewaldcoeff_lj;
 292
 293     //! Coulomb cut-off squared
 294     float rcoulomb_sq;
 295
 296     //! VdW cut-off squared
 297     float rvdw_sq;
 298     //! VdW switched cut-off
 299     float rvdw_switch;
 300     //! Full, outer pair-list cut-off squared
 301     float rlistOuter_sq;
 302     //! Inner, dynamic pruned pair-list cut-off squared
 303     float rlistInner_sq;
 304
 305     //! VdW shift dispersion constants
 306     shift_consts_t dispersion_shift;
 307     //! VdW shift repulsion constants
 308     shift_consts_t repulsion_shift;
 309     //! VdW switch constants
 310     switch_consts_t vdw_switch;
 311
 312     /* Ewald Coulomb force table data - accessed through texture memory */
 313     //! table scale/spacing
 314     float coulomb_tab_scale;
 315 } cl_nbparam_params_t;
 316
 317
 318 /*! \internal
 319  * \brief Pair list data.
 320  */
 321 using cl_plist_t = Nbnxm::gpu_plist;
 322
 323 /** \internal
 324  * \brief Typedef of actual timer type.
 325  */
 326 typedef struct Nbnxm::gpu_timers_t cl_timers_t;
 327
 328 /*! \internal
 329  * \brief Main data structure for OpenCL nonbonded force calculations.
 330  */
 331 struct NbnxmGpu
 332 {
 333     //! OpenCL device information
 334     const DeviceInformation* deviceInfo = nullptr;
 335     //! OpenCL runtime data (context, kernels)
 336     struct gmx_device_runtime_data_t* dev_rundata = nullptr;
 337
 338     /**< Pointers to non-bonded kernel functions
 339      * organized similar with nb_kfunc_xxx arrays in nbnxn_ocl.cpp */
 340     ///@{
 341     cl_kernel kernel_noener_noprune_ptr[eelOclNR][evdwOclNR] = { { nullptr } };
 342     cl_kernel kernel_ener_noprune_ptr[eelOclNR][evdwOclNR]   = { { nullptr } };
 343     cl_kernel kernel_noener_prune_ptr[eelOclNR][evdwOclNR]   = { { nullptr } };
 344     cl_kernel kernel_ener_prune_ptr[eelOclNR][evdwOclNR]     = { { nullptr } };
 345     ///@}
 346     //! prune kernels, ePruneKind defined the kernel kinds
 347     cl_kernel kernel_pruneonly[ePruneNR] = { nullptr };
 348
 349     //! true if prefetching fg i-atom LJ parameters should be used in the kernels
 350     bool bPrefetchLjParam = false;
 351
 352     /**< auxiliary kernels implementing memset-like functions */
 353     ///@{
 354     cl_kernel kernel_memset_f      = nullptr;
 355     cl_kernel kernel_memset_f2     = nullptr;
 356     cl_kernel kernel_memset_f3     = nullptr;
 357     cl_kernel kernel_zero_e_fshift = nullptr;
 358     ///@}
 359
 360     //! true if doing both local/non-local NB work on GPU
 361     bool bUseTwoStreams = false;
 362     //! true indicates that the nonlocal_done event was enqueued
 363     bool bNonLocalStreamActive = false;
 364
 365     //! atom data
 366     cl_atomdata_t* atdat = nullptr;
 367     //! parameters required for the non-bonded calc.
 368     cl_nbparam_t* nbparam = nullptr;
 369     //! pair-list data structures (local and non-local)
 370     gmx::EnumerationArray<Nbnxm::InteractionLocality, cl_plist_t*> plist = { nullptr };
 371     //! staging area where fshift/energies get downloaded
 372     nb_staging_t nbst;
 373
 374     //! local and non-local GPU queues
 375     gmx::EnumerationArray<Nbnxm::InteractionLocality, cl_command_queue> stream;
 376
 377     /*! \brief Events used for synchronization */
 378     /*! \{ */
 379     /*! \brief Event triggered when the non-local non-bonded
 380      * kernel is done (and the local transfer can proceed) */
 381     cl_event nonlocal_done = nullptr;
 382     /*! \brief Event triggered when the tasks issued in the local
 383      * stream that need to precede the non-local force or buffer
 384      * operation calculations are done (e.g. f buffer 0-ing, local
 385      * x/q H2D, buffer op initialization in local stream that is
 386      * required also by nonlocal stream ) */
 387     cl_event misc_ops_and_local_H2D_done = nullptr;
 388     /*! \} */
 389
 390     //! True if there has been local/nonlocal GPU work, either bonded or nonbonded, scheduled
 391     //  to be executed in the current domain. As long as bonded work is not split up into
 392     //  local/nonlocal, if there is bonded GPU work, both flags will be true.
 393     gmx::EnumerationArray<Nbnxm::InteractionLocality, bool> haveWork;
 394
 395
 396     //! True if event-based timing is enabled.
 397     bool bDoTime = false;
 398     //! OpenCL event-based timers.
 399     cl_timers_t* timers = nullptr;
 400     //! Timing data. TODO: deprecate this and query timers for accumulated data instead
 401     gmx_wallclock_gpu_nbnxn_t* timings = nullptr;
 402 };
 403
 404 #endif /* NBNXN_OPENCL_TYPES_H */