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