src/gromacs/mdlib/nbnxn_ocl/nbnxn_ocl_types.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2016,2017,2018, 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
  36 /*! \internal \file
  37  *  \brief
  38  *  Data types used internally in the nbnxn_ocl module.
  39  *
  40  *  \author Anca Hamuraru <anca@streamcomputing.eu>
  41  *  \author Szilárd Páll <pszilard@kth.se>
  42  *  \ingroup module_mdlib
  43  */
  44
  45 #ifndef NBNXN_OPENCL_TYPES_H
  46 #define NBNXN_OPENCL_TYPES_H
  47
  48 #include "gromacs/gpu_utils/devicebuffer.h"
  49 #include "gromacs/gpu_utils/gmxopencl.h"
  50 #include "gromacs/gpu_utils/gputraits_ocl.h"
  51 #include "gromacs/gpu_utils/oclutils.h"
  52 #include "gromacs/mdlib/nbnxn_gpu_types_common.h"
  53 #include "gromacs/mdlib/nbnxn_pairlist.h"
  54 #include "gromacs/mdlib/nbnxn_ocl/nbnxn_ocl_consts.h"
  55 #include "gromacs/mdtypes/interaction_const.h"
  56 #include "gromacs/utility/fatalerror.h"
  57 #include "gromacs/utility/real.h"
  58
  59 /* kernel does #include "gromacs/math/utilities.h" */
  60 /* Move the actual useful stuff here: */
  61
  62 //! Define 1/sqrt(pi)
  63 #define M_FLOAT_1_SQRTPI 0.564189583547756f
  64
  65 /*! @} */
  66 /*! \brief Constants for platform-dependent defaults for the prune kernel's j4 processing concurrency.
  67  *
  68  *  Initialized using macros that can be overridden at compile-time (using #GMX_NBNXN_PRUNE_KERNEL_J4_CONCURRENCY).
  69  */
  70 /*! @{ */
  71 const int c_oclPruneKernelJ4ConcurrencyDEFAULT     = GMX_NBNXN_PRUNE_KERNEL_J4_CONCURRENCY_DEFAULT;
  72 /*! @} */
  73
  74 /*! \brief Returns the j4 processing concurrency parameter for the vendor \p vendorId
  75  *  \param vendorId takes values from #ocl_vendor_id_t.
  76  */
  77 static inline int getOclPruneKernelJ4Concurrency(int vendorId)
  78 {
  79     switch (vendorId)
  80     {
  81         default: return c_oclPruneKernelJ4ConcurrencyDEFAULT;
  82     }
  83 }
  84
  85
  86 /*! \brief Electrostatic OpenCL kernel flavors.
  87  *
  88  *  Types of electrostatics implementations available in the OpenCL non-bonded
  89  *  force kernels. These represent both the electrostatics types implemented
  90  *  by the kernels (cut-off, RF, and Ewald - a subset of what's defined in
  91  *  enums.h) as well as encode implementation details analytical/tabulated
  92  *  and single or twin cut-off (for Ewald kernels).
  93  *  Note that the cut-off and RF kernels have only analytical flavor and unlike
  94  *  in the CPU kernels, the tabulated kernels are ATM Ewald-only.
  95  *
  96  *  The row-order of pointers to different electrostatic kernels defined in
  97  *  nbnxn_cuda.cu by the nb_*_kfunc_ptr function pointer table
  98  *  should match the order of enumerated types below.
  99  */
 100 enum eelOcl {
 101     eelOclCUT, eelOclRF, eelOclEWALD_TAB, eelOclEWALD_TAB_TWIN, eelOclEWALD_ANA, eelOclEWALD_ANA_TWIN, eelOclNR
 102 };
 103
 104 /*! \brief VdW OpenCL kernel flavors.
 105  *
 106  * The enumerates values correspond to the LJ implementations in the OpenCL non-bonded
 107  * kernels.
 108  *
 109  * The column-order of pointers to different electrostatic kernels defined in
 110  * nbnxn_cuda.cu by the nb_*_kfunc_ptr function pointer table
 111  * should match the order of enumerated types below.
 112  */
 113 enum evdwOcl {
 114     evdwOclCUT, evdwOclCUTCOMBGEOM, evdwOclCUTCOMBLB, evdwOclFSWITCH, evdwOclPSWITCH, evdwOclEWALDGEOM, evdwOclEWALDLB, evdwOclNR
 115 };
 116
 117 /*! \brief Pruning kernel flavors.
 118  *
 119  * The values correspond to the first call of the pruning post-list generation
 120  * and the rolling pruning, respectively.
 121  */
 122 enum ePruneKind {
 123     epruneFirst, epruneRolling, ePruneNR
 124 };
 125
 126 /*! \internal
 127  * \brief Staging area for temporary data downloaded from the GPU.
 128  *
 129  *  The energies/shift forces get downloaded here first, before getting added
 130  *  to the CPU-side aggregate values.
 131  */
 132 typedef struct cl_nb_staging
 133 {
 134     float    *e_lj;           /**< LJ energy                       */
 135     float    *e_el;           /**< electrostatic energy            */
 136     float   (*fshift)[3];     /**< float3 buffer with shift forces */
 137 } cl_nb_staging_t;
 138
 139 /*! \internal
 140  * \brief Nonbonded atom data - both inputs and outputs.
 141  */
 142 typedef struct cl_atomdata
 143 {
 144     int         natoms;              /**< number of atoms                              */
 145     int         natoms_local;        /**< number of local atoms                        */
 146     int         nalloc;              /**< allocation size for the atom data (xq, f)    */
 147
 148     cl_mem      xq;                  /**< float4 buffer with atom coordinates + charges, size natoms */
 149
 150     cl_mem      f;                   /**< float3 buffer with force output array, size natoms         */
 151     size_t      f_elem_size;         /**< Size in bytes for one element of f buffer      */
 152
 153     cl_mem      e_lj;                /**< LJ energy output, size 1                       */
 154     cl_mem      e_el;                /**< Electrostatics energy input, size 1            */
 155
 156     cl_mem      fshift;              /**< float3 buffer with shift forces                */
 157     size_t      fshift_elem_size;    /**< Size in bytes for one element of fshift buffer */
 158
 159     int         ntypes;              /**< number of atom types                           */
 160     cl_mem      atom_types;          /**< int buffer with atom type indices, size natoms */
 161     cl_mem      lj_comb;             /**< float2 buffer with sqrt(c6),sqrt(c12), size natoms */
 162
 163     cl_mem      shift_vec;           /**< float3 buffer with shifts values               */
 164     size_t      shift_vec_elem_size; /**< Size in bytes for one element of shift_vec buffer */
 165
 166     cl_bool     bShiftVecUploaded;   /**< true if the shift vector has been uploaded  */
 167 } cl_atomdata_t;
 168
 169 /*! \internal
 170  * \brief Parameters required for the OpenCL nonbonded calculations.
 171  */
 172 typedef struct cl_nbparam
 173 {
 174
 175     int             eeltype;           /**< type of electrostatics, takes values from #eelOcl */
 176     int             vdwtype;           /**< type of VdW impl., takes values from #evdwOcl     */
 177
 178     float           epsfac;            /**< charge multiplication factor                      */
 179     float           c_rf;              /**< Reaction-field/plain cutoff electrostatics const. */
 180     float           two_k_rf;          /**< Reaction-field electrostatics constant            */
 181     float           ewald_beta;        /**< Ewald/PME parameter                               */
 182     float           sh_ewald;          /**< Ewald/PME correction term substracted from the direct-space potential */
 183     float           sh_lj_ewald;       /**< LJ-Ewald/PME correction term added to the correction potential        */
 184     float           ewaldcoeff_lj;     /**< LJ-Ewald/PME coefficient                          */
 185
 186     float           rcoulomb_sq;       /**< Coulomb cut-off squared                           */
 187
 188     float           rvdw_sq;           /**< VdW cut-off squared                               */
 189     float           rvdw_switch;       /**< VdW switched cut-off                              */
 190     float           rlistOuter_sq;     /**< Full, outer pair-list cut-off squared             */
 191     float           rlistInner_sq;     /**< Inner, dynamic pruned pair-list cut-off squared   */
 192     bool            useDynamicPruning; /**< True if we use dynamic pair-list pruning          */
 193
 194     shift_consts_t  dispersion_shift;  /**< VdW shift dispersion constants           */
 195     shift_consts_t  repulsion_shift;   /**< VdW shift repulsion constants            */
 196     switch_consts_t vdw_switch;        /**< VdW switch constants                     */
 197
 198     /* LJ non-bonded parameters - accessed through texture memory */
 199     cl_mem                  nbfp_climg2d;      /**< nonbonded parameter table with C6/C12 pairs per atom type-pair, 2*ntype^2 elements */
 200     cl_mem                  nbfp_comb_climg2d; /**< nonbonded parameter table per atom type, 2*ntype elements                          */
 201
 202     /* Ewald Coulomb force table data - accessed through texture memory */
 203     float                  coulomb_tab_scale;   /**< table scale/spacing                        */
 204     cl_mem                 coulomb_tab_climg2d; /**< pointer to the table in the device memory  */
 205 } cl_nbparam_t;
 206
 207 /*! \internal
 208  * \brief Data structure shared between the OpenCL device code and OpenCL host code
 209  *
 210  * Must not contain OpenCL objects (buffers)
 211  * TODO: review, improve */
 212 typedef struct cl_nbparam_params
 213 {
 214
 215     int             eeltype;          /**< type of electrostatics, takes values from #eelCu */
 216     int             vdwtype;          /**< type of VdW impl., takes values from #evdwCu     */
 217
 218     float           epsfac;           /**< charge multiplication factor                      */
 219     float           c_rf;             /**< Reaction-field/plain cutoff electrostatics const. */
 220     float           two_k_rf;         /**< Reaction-field electrostatics constant            */
 221     float           ewald_beta;       /**< Ewald/PME parameter                               */
 222     float           sh_ewald;         /**< Ewald/PME correction term substracted from the direct-space potential */
 223     float           sh_lj_ewald;      /**< LJ-Ewald/PME correction term added to the correction potential        */
 224     float           ewaldcoeff_lj;    /**< LJ-Ewald/PME coefficient                          */
 225
 226     float           rcoulomb_sq;      /**< Coulomb cut-off squared                           */
 227
 228     float           rvdw_sq;          /**< VdW cut-off squared                               */
 229     float           rvdw_switch;      /**< VdW switched cut-off                              */
 230     float           rlistOuter_sq;    /**< Full, outer pair-list cut-off squared             */
 231     float           rlistInner_sq;    /**< Inner, dynamic pruned pair-list cut-off squared   */
 232
 233     shift_consts_t  dispersion_shift; /**< VdW shift dispersion constants           */
 234     shift_consts_t  repulsion_shift;  /**< VdW shift repulsion constants            */
 235     switch_consts_t vdw_switch;       /**< VdW switch constants                     */
 236
 237     /* Ewald Coulomb force table data - accessed through texture memory */
 238     float                  coulomb_tab_scale;  /**< table scale/spacing                        */
 239 } cl_nbparam_params_t;
 240
 241
 242 /*! \internal
 243  * \brief Pair list data.
 244  */
 245 using cl_plist_t = gpu_plist;
 246
 247 /** \internal
 248  * \brief Typedef of actual timer type.
 249  */
 250 typedef struct nbnxn_gpu_timers_t cl_timers_t;
 251
 252 /*! \internal
 253  * \brief Main data structure for OpenCL nonbonded force calculations.
 254  */
 255 struct gmx_nbnxn_ocl_t
 256 {
 257     const gmx_device_info_t          *dev_info;    /**< OpenCL device information                              */
 258     struct gmx_device_runtime_data_t *dev_rundata; /**< OpenCL runtime data (context, kernels)                 */
 259
 260     /**< Pointers to non-bonded kernel functions
 261      * organized similar with nb_kfunc_xxx arrays in nbnxn_ocl.cpp */
 262     ///@{
 263     cl_kernel           kernel_noener_noprune_ptr[eelOclNR][evdwOclNR];
 264     cl_kernel           kernel_ener_noprune_ptr[eelOclNR][evdwOclNR];
 265     cl_kernel           kernel_noener_prune_ptr[eelOclNR][evdwOclNR];
 266     cl_kernel           kernel_ener_prune_ptr[eelOclNR][evdwOclNR];
 267     ///@}
 268     cl_kernel           kernel_pruneonly[ePruneNR]; /**< prune kernels, ePruneKind defined the kernel kinds */
 269
 270     bool                bPrefetchLjParam;           /**< true if prefetching fg i-atom LJ parameters should be used in the kernels */
 271
 272     /**< auxiliary kernels implementing memset-like functions */
 273     ///@{
 274     cl_kernel           kernel_memset_f;
 275     cl_kernel           kernel_memset_f2;
 276     cl_kernel           kernel_memset_f3;
 277     cl_kernel           kernel_zero_e_fshift;
 278     ///@}
 279
 280     cl_bool             bUseTwoStreams;        /**< true if doing both local/non-local NB work on GPU          */
 281     cl_bool             bNonLocalStreamActive; /**< true indicates that the nonlocal_done event was enqueued   */
 282
 283     cl_atomdata_t      *atdat;                 /**< atom data                                                  */
 284     cl_nbparam_t       *nbparam;               /**< parameters required for the non-bonded calc.               */
 285     cl_plist_t         *plist[2];              /**< pair-list data structures (local and non-local)            */
 286     cl_nb_staging_t     nbst;                  /**< staging area where fshift/energies get downloaded          */
 287
 288     cl_command_queue    stream[2];             /**< local and non-local GPU queues                             */
 289
 290     /** events used for synchronization */
 291     cl_event nonlocal_done;                     /**< event triggered when the non-local non-bonded kernel
 292                                                    is done (and the local transfer can proceed) */
 293     cl_event misc_ops_and_local_H2D_done;       /**< event triggered when the tasks issued in
 294                                                    the local stream that need to precede the
 295                                                    non-local force calculations are done
 296                                                    (e.g. f buffer 0-ing, local x/q H2D) */
 297
 298     cl_bool                           bDoTime;  /**< True if event-based timing is enabled.                     */
 299     cl_timers_t                      *timers;   /**< OpenCL event-based timers.                                 */
 300     struct gmx_wallclock_gpu_nbnxn_t *timings;  /**< Timing data. TODO: deprecate this and query timers for accumulated data instead */
 301 };
 302
 303 #endif  /* NBNXN_OPENCL_TYPES_H */