src/gromacs/nbnxm/nbnxm.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2017 by the GROMACS development team.
   5  * Copyright (c) 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 // FIXME: remove the "__" prefix in front of the group def when we move the
  38 //        nonbonded code into separate dir.
  39
  40 /*! \libinternal \defgroup __module_nbnxm Short-range non-bonded interaction module
  41  * \ingroup group_mdrun
  42  *
  43  * \brief Computes forces and energies for short-range pair-interactions
  44  * based on the Verlet algorithm. The algorithm uses pair-lists generated
  45  * at fixed intervals as well as various flavors of pair interaction kernels
  46  * implemented for a wide range of CPU and GPU architectures.
  47  *
  48  * The module includes support for flavors of Coulomb and Lennard-Jones interaction
  49  * treatment implemented for a large range of SIMD instruction sets for CPU
  50  * architectures as well as in CUDA and OpenCL for GPU architectures.
  51  * Additionally there is a reference CPU non-SIMD and a reference CPU
  52  * for GPU pair-list setup interaction kernel.
  53  *
  54  * The implementation of the kernels is based on the cluster non-bonded algorithm
  55  * which in the code is referred to as the NxM algorithms ("nbnxm_" prefix);
  56  * for details of the algorithm see DOI:10.1016/j.cpc.2013.06.003.
  57  *
  58  * Algorithmically, the non-bonded computation has two different modes:
  59  * A "classical" mode: generate a list every nstlist steps containing at least
  60  * all atom pairs up to a distance of rlistOuter and compute pair interactions
  61  * for all pairs that are within the interaction cut-off.
  62  * A "dynamic pruning" mode: generate an "outer-list" up to cut-off rlistOuter
  63  * every nstlist steps and prune the outer-list using a cut-off of rlistInner
  64  * every nstlistPrune steps to obtain a, smaller, "inner-list". This
  65  * results in fewer interaction computations and allows for a larger nstlist.
  66  * On a GPU, this dynamic pruning is performed in a rolling fashion, pruning
  67  * only a sub-part of the list each (second) step. This way it can often
  68  * overlap with integration and constraints on the CPU.
  69  * Currently a simple heuristic determines which mode will be used.
  70  *
  71  * TODO: add a summary list and brief descriptions of the different submodules:
  72  * search, CPU kernels, GPU glue code + kernels.
  73  *
  74  * \author Berk Hess <hess@kth.se>
  75  * \author Szilárd Páll <pall.szilard@gmail.com>
  76  * \author Mark Abraham <mark.j.abraham@gmail.com>
  77  * \author Anca Hamuraru <anca@streamcomputing.eu>
  78  * \author Teemu Virolainen <teemu@streamcomputing.eu>
  79  * \author Dimitrios Karkoulis <dimitris.karkoulis@gmail.com>
  80  *
  81  * TODO: add more authors!
  82  */
  83
  84 /*! \libinternal
  85  * \defgroup module_nbnxm Non-bonded pair interactions
  86  * \ingroup group_mdrun
  87  * \brief
  88  * Implements non-bonded pair interaction functionality for NxM atom clusters.
  89  *
  90  * This module provides methods to, very efficiently, compute non-bonded
  91  * pair interactions on CPUs as well as accelerators. It also provides
  92  * a method to construct the NxM atom-cluster pair-list required for
  93  * computing these non-bonded iteractions.
  94  */
  95
  96 /*! \libinternal \file
  97  *
  98  * \brief This file contains the public interface of the nbnxm module
  99  * that implements the NxM atom cluster non-bonded algorithm to efficiently
 100  * compute pair forces.
 101  *
 102  *
 103  * \author Berk Hess <hess@kth.se>
 104  * \author Szilárd Páll <pall.szilard@gmail.com>
 105  *
 106  * \inlibraryapi
 107  * \ingroup module_nbnxm
 108  */
 109
 110
 111 #ifndef GMX_NBNXM_NBNXM_H
 112 #define GMX_NBNXM_NBNXM_H
 113
 114 #include <memory>
 115
 116 #include "gromacs/gpu_utils/devicebuffer_datatype.h"
 117 #include "gromacs/math/vectypes.h"
 118 #include "gromacs/mdtypes/locality.h"
 119 #include "gromacs/utility/arrayref.h"
 120 #include "gromacs/utility/enumerationhelpers.h"
 121 #include "gromacs/utility/range.h"
 122 #include "gromacs/utility/real.h"
 123
 124 // TODO: Remove this include
 125 #include "nbnxm_gpu.h"
 126
 127 struct gmx_device_info_t;
 128 struct gmx_domdec_zones_t;
 129 struct gmx_enerdata_t;
 130 struct gmx_hw_info_t;
 131 struct gmx_mtop_t;
 132 struct gmx_wallcycle;
 133 struct interaction_const_t;
 134 struct nonbonded_verlet_t;
 135 class PairSearch;
 136 class PairlistSets;
 137 struct t_commrec;
 138 struct t_lambda;
 139 struct t_mdatoms;
 140 struct t_nrnb;
 141 struct t_forcerec;
 142 struct t_inputrec;
 143
 144 /*! \brief Switch for whether to use GPU for buffer ops*/
 145 enum class BufferOpsUseGpu
 146 {
 147     True,
 148     False
 149 };
 150
 151 class GpuEventSynchronizer;
 152
 153 namespace gmx
 154 {
 155 class ForceWithShiftForces;
 156 template<typename>
 157 class ListOfLists;
 158 class MDLogger;
 159 class UpdateGroupsCog;
 160 } // namespace gmx
 161
 162 namespace Nbnxm
 163 {
 164 enum class KernelType;
 165 }
 166
 167 namespace Nbnxm
 168 {
 169
 170 /*! \brief Nonbonded NxN kernel types: plain C, CPU SIMD, GPU, GPU emulation */
 171 enum class KernelType : int
 172 {
 173     NotSet = 0,
 174     Cpu4x4_PlainC,
 175     Cpu4xN_Simd_4xN,
 176     Cpu4xN_Simd_2xNN,
 177     Gpu8x8x8,
 178     Cpu8x8x8_PlainC,
 179     Count
 180 };
 181
 182 /*! \brief Ewald exclusion types */
 183 enum class EwaldExclusionType : int
 184 {
 185     NotSet = 0,
 186     Table,
 187     Analytical,
 188     DecidedByGpuModule
 189 };
 190
 191 /* \brief The non-bonded setup, also affects the pairlist construction kernel */
 192 struct KernelSetup
 193 {
 194     //! The non-bonded type, also affects the pairlist construction kernel
 195     KernelType kernelType = KernelType::NotSet;
 196     //! Ewald exclusion computation handling type, currently only used for CPU
 197     EwaldExclusionType ewaldExclusionType = EwaldExclusionType::NotSet;
 198 };
 199
 200 /*! \brief Return a string identifying the kernel type.
 201  *
 202  * \param [in] kernelType   nonbonded kernel type, takes values from the nbnxn_kernel_type enum
 203  * \returns                 a string identifying the kernel corresponding to the type passed as argument
 204  */
 205 const char* lookup_kernel_name(Nbnxm::KernelType kernelType);
 206
 207 } // namespace Nbnxm
 208
 209 /*! \brief Flag to tell the nonbonded kernels whether to clear the force output buffers */
 210 enum
 211 {
 212     enbvClearFNo,
 213     enbvClearFYes
 214 };
 215
 216 /*! \libinternal
 217  *  \brief Top-level non-bonded data structure for the Verlet-type cut-off scheme. */
 218 struct nonbonded_verlet_t
 219 {
 220 public:
 221     //! Constructs an object from its components
 222     nonbonded_verlet_t(std::unique_ptr<PairlistSets>     pairlistSets,
 223                        std::unique_ptr<PairSearch>       pairSearch,
 224                        std::unique_ptr<nbnxn_atomdata_t> nbat,
 225                        const Nbnxm::KernelSetup&         kernelSetup,
 226                        gmx_nbnxn_gpu_t*                  gpu_nbv,
 227                        gmx_wallcycle*                    wcycle);
 228
 229     ~nonbonded_verlet_t();
 230
 231     //! Returns whether a GPU is use for the non-bonded calculations
 232     bool useGpu() const { return kernelSetup_.kernelType == Nbnxm::KernelType::Gpu8x8x8; }
 233
 234     //! Returns whether a GPU is emulated for the non-bonded calculations
 235     bool emulateGpu() const
 236     {
 237         return kernelSetup_.kernelType == Nbnxm::KernelType::Cpu8x8x8_PlainC;
 238     }
 239
 240     //! Return whether the pairlist is of simple, CPU type
 241     bool pairlistIsSimple() const { return !useGpu() && !emulateGpu(); }
 242
 243     //! Initialize the pair list sets, TODO this should be private
 244     void initPairlistSets(bool haveMultipleDomains);
 245
 246     //! Returns the order of the local atoms on the grid
 247     gmx::ArrayRef<const int> getLocalAtomOrder() const;
 248
 249     //! Sets the order of the local atoms to the order grid atom ordering
 250     void setLocalAtomOrder();
 251
 252     //! Returns the index position of the atoms on the search grid
 253     gmx::ArrayRef<const int> getGridIndices() const;
 254
 255     //! Constructs the pairlist for the given locality
 256     void constructPairlist(gmx::InteractionLocality     iLocality,
 257                            const gmx::ListOfLists<int>& exclusions,
 258                            int64_t                      step,
 259                            t_nrnb*                      nrnb);
 260
 261     //! Updates all the atom properties in Nbnxm
 262     void setAtomProperties(const t_mdatoms& mdatoms, gmx::ArrayRef<const int> atomInfo);
 263
 264     /*!\brief Convert the coordinates to NBNXM format for the given locality.
 265      *
 266      * The API function for the transformation of the coordinates from one layout to another.
 267      *
 268      * \param[in] locality     Whether coordinates for local or non-local atoms should be
 269      * transformed. \param[in] fillLocal    If the coordinates for filler particles should be
 270      * zeroed. \param[in] coordinates  Coordinates in plain rvec format to be transformed.
 271      */
 272     void convertCoordinates(gmx::AtomLocality locality, bool fillLocal, gmx::ArrayRef<const gmx::RVec> coordinates);
 273
 274     /*!\brief Convert the coordinates to NBNXM format on the GPU for the given locality
 275      *
 276      * The API function for the transformation of the coordinates from one layout to another in the GPU memory.
 277      *
 278      * \param[in] locality        Whether coordinates for local or non-local atoms should be transformed.
 279      * \param[in] fillLocal       If the coordinates for filler particles should be zeroed.
 280      * \param[in] d_x             GPU coordinates buffer in plain rvec format to be transformed.
 281      * \param[in] xReadyOnDevice  Event synchronizer indicating that the coordinates are ready in the device memory.
 282      */
 283     void convertCoordinatesGpu(gmx::AtomLocality     locality,
 284                                bool                  fillLocal,
 285                                DeviceBuffer<float>   d_x,
 286                                GpuEventSynchronizer* xReadyOnDevice);
 287
 288     //! Init for GPU version of setup coordinates in Nbnxm
 289     void atomdata_init_copy_x_to_nbat_x_gpu();
 290
 291     //! Sync the nonlocal GPU stream with dependent tasks in the local queue.
 292     void insertNonlocalGpuDependency(gmx::InteractionLocality interactionLocality);
 293
 294     //! Returns a reference to the pairlist sets
 295     const PairlistSets& pairlistSets() const { return *pairlistSets_; }
 296
 297     //! Returns whether step is a dynamic list pruning step, for CPU lists
 298     bool isDynamicPruningStepCpu(int64_t step) const;
 299
 300     //! Returns whether step is a dynamic list pruning step, for GPU lists
 301     bool isDynamicPruningStepGpu(int64_t step) const;
 302
 303     //! Dispatches the dynamic pruning kernel for the given locality, for CPU lists
 304     void dispatchPruneKernelCpu(gmx::InteractionLocality iLocality, const rvec* shift_vec);
 305
 306     //! Dispatches the dynamic pruning kernel for GPU lists
 307     void dispatchPruneKernelGpu(int64_t step);
 308
 309     //! \brief Executes the non-bonded kernel of the GPU or launches it on the GPU
 310     void dispatchNonbondedKernel(gmx::InteractionLocality   iLocality,
 311                                  const interaction_const_t& ic,
 312                                  const gmx::StepWorkload&   stepWork,
 313                                  int                        clearF,
 314                                  const t_forcerec&          fr,
 315                                  gmx_enerdata_t*            enerd,
 316                                  t_nrnb*                    nrnb);
 317
 318     //! Executes the non-bonded free-energy kernel, always runs on the CPU
 319     void dispatchFreeEnergyKernel(gmx::InteractionLocality   iLocality,
 320                                   const t_forcerec*          fr,
 321                                   rvec                       x[],
 322                                   gmx::ForceWithShiftForces* forceWithShiftForces,
 323                                   const t_mdatoms&           mdatoms,
 324                                   t_lambda*                  fepvals,
 325                                   real*                      lambda,
 326                                   gmx_enerdata_t*            enerd,
 327                                   const gmx::StepWorkload&   stepWork,
 328                                   t_nrnb*                    nrnb);
 329
 330     /*! \brief Add the forces stored in nbat to f, zeros the forces in nbat
 331      * \param [in] locality         Local or non-local
 332      * \param [inout] force         Force to be added to
 333      */
 334     void atomdata_add_nbat_f_to_f(gmx::AtomLocality locality, gmx::ArrayRef<gmx::RVec> force);
 335
 336     /*! \brief Add the forces stored in nbat to total force using GPU buffer opse
 337      *
 338      * \param [in]     locality             Local or non-local
 339      * \param [in,out] totalForcesDevice    Force to be added to
 340      * \param [in]     forcesPmeDevice      Device buffer with PME forces
 341      * \param[in]      dependencyList       List of synchronizers that represent the dependencies the reduction task needs to sync on.
 342      * \param [in]     useGpuFPmeReduction  Whether PME forces should be added
 343      * \param [in]     accumulateForce      If the total force buffer already contains data
 344      */
 345     void atomdata_add_nbat_f_to_f_gpu(gmx::AtomLocality                          locality,
 346                                       DeviceBuffer<float>                        totalForcesDevice,
 347                                       void*                                      forcesPmeDevice,
 348                                       gmx::ArrayRef<GpuEventSynchronizer* const> dependencyList,
 349                                       bool useGpuFPmeReduction,
 350                                       bool accumulateForce);
 351
 352     /*! \brief Outer body of function to perform initialization for F buffer operations on GPU.
 353      *
 354      * \param localReductionDone     Pointer to an event synchronizer that marks the completion of the local f buffer ops kernel.
 355      */
 356     void atomdata_init_add_nbat_f_to_f_gpu(GpuEventSynchronizer* localReductionDone);
 357
 358     /*! \brief return GPU pointer to f in rvec format */
 359     void* get_gpu_frvec();
 360
 361     //! Return the kernel setup
 362     const Nbnxm::KernelSetup& kernelSetup() const { return kernelSetup_; }
 363
 364     //! Returns the outer radius for the pair list
 365     real pairlistInnerRadius() const;
 366
 367     //! Returns the outer radius for the pair list
 368     real pairlistOuterRadius() const;
 369
 370     //! Changes the pair-list outer and inner radius
 371     void changePairlistRadii(real rlistOuter, real rlistInner);
 372
 373     //! Set up internal flags that indicate what type of short-range work there is.
 374     void setupGpuShortRangeWork(const gmx::GpuBonded* gpuBonded, const gmx::InteractionLocality iLocality)
 375     {
 376         if (useGpu() && !emulateGpu())
 377         {
 378             Nbnxm::setupGpuShortRangeWork(gpu_nbv, gpuBonded, iLocality);
 379         }
 380     }
 381
 382     //! Returns true if there is GPU short-range work for the given atom locality.
 383     bool haveGpuShortRangeWork(const gmx::AtomLocality aLocality)
 384     {
 385         return ((useGpu() && !emulateGpu()) && Nbnxm::haveGpuShortRangeWork(gpu_nbv, aLocality));
 386     }
 387
 388     // TODO: Make all data members private
 389 public:
 390     //! All data related to the pair lists
 391     std::unique_ptr<PairlistSets> pairlistSets_;
 392     //! Working data for constructing the pairlists
 393     std::unique_ptr<PairSearch> pairSearch_;
 394     //! Atom data
 395     std::unique_ptr<nbnxn_atomdata_t> nbat;
 396
 397 private:
 398     //! The non-bonded setup, also affects the pairlist construction kernel
 399     Nbnxm::KernelSetup kernelSetup_;
 400     //! \brief Pointer to wallcycle structure.
 401     gmx_wallcycle* wcycle_;
 402
 403 public:
 404     //! GPU Nbnxm data, only used with a physical GPU (TODO: use unique_ptr)
 405     gmx_nbnxn_gpu_t* gpu_nbv;
 406 };
 407
 408 namespace Nbnxm
 409 {
 410
 411 /*! \brief Creates an Nbnxm object */
 412 std::unique_ptr<nonbonded_verlet_t> init_nb_verlet(const gmx::MDLogger&     mdlog,
 413                                                    gmx_bool                 bFEP_NonBonded,
 414                                                    const t_inputrec*        ir,
 415                                                    const t_forcerec*        fr,
 416                                                    const t_commrec*         cr,
 417                                                    const gmx_hw_info_t&     hardwareInfo,
 418                                                    const gmx_device_info_t* deviceInfo,
 419                                                    const gmx_mtop_t*        mtop,
 420                                                    matrix                   box,
 421                                                    gmx_wallcycle*           wcycle);
 422
 423 } // namespace Nbnxm
 424
 425 /*! \brief Put the atoms on the pair search grid.
 426  *
 427  * Only atoms with indices wihtin \p atomRange in x are put on the grid.
 428  * When \p updateGroupsCog != nullptr, atoms are put on the grid
 429  * based on the center of geometry of the group they belong to.
 430  * Atoms or COGs of groups should be within the bounding box provided,
 431  * this is checked in debug builds when not using update groups.
 432  * The atom density is used to determine the grid size when \p gridIndex = 0.
 433  * When \p atomDensity <= 0, the density is determined from atomEnd-atomStart
 434  * and the bounding box corners.
 435  * With domain decomposition, part of the atoms might have migrated,
 436  * but have not been removed yet. This count is given by \p numAtomsMoved.
 437  * When \p move[i] < 0 particle i has migrated and will not be put on the grid.
 438  *
 439  * \param[in,out] nb_verlet    The non-bonded object
 440  * \param[in]     box          Box used for periodic distance calculations
 441  * \param[in]     gridIndex    The index of the grid to spread to, always 0 except with test particle insertion
 442  * \param[in]     lowerCorner  Atom groups to be gridded should have coordinates >= this corner
 443  * \param[in]     upperCorner  Atom groups to be gridded should have coordinates <= this corner
 444  * \param[in]     updateGroupsCog  Centers of geometry for update groups, pass nullptr when not using update groups
 445  * \param[in]     atomRange    Range of atoms to grid
 446  * \param[in]     atomDensity  An estimate of the atom density, used for peformance optimization and only with \p gridIndex = 0
 447  * \param[in]     atomInfo     Atom information flags
 448  * \param[in]     x            Coordinates for atoms to grid
 449  * \param[in]     numAtomsMoved  The number of atoms that will move to another domain, pass 0 without DD
 450  * \param[in]     move         Move flags for atoms, pass nullptr without DD
 451  */
 452 void nbnxn_put_on_grid(nonbonded_verlet_t*            nb_verlet,
 453                        const matrix                   box,
 454                        int                            gridIndex,
 455                        const rvec                     lowerCorner,
 456                        const rvec                     upperCorner,
 457                        const gmx::UpdateGroupsCog*    updateGroupsCog,
 458                        gmx::Range<int>                atomRange,
 459                        real                           atomDensity,
 460                        gmx::ArrayRef<const int>       atomInfo,
 461                        gmx::ArrayRef<const gmx::RVec> x,
 462                        int                            numAtomsMoved,
 463                        const int*                     move);
 464
 465 /*! \brief As nbnxn_put_on_grid, but for the non-local atoms
 466  *
 467  * with domain decomposition. Should be called after calling
 468  * nbnxn_search_put_on_grid for the local atoms / home zone.
 469  */
 470 void nbnxn_put_on_grid_nonlocal(nonbonded_verlet_t*              nb_verlet,
 471                                 const struct gmx_domdec_zones_t* zones,
 472                                 gmx::ArrayRef<const int>         atomInfo,
 473                                 gmx::ArrayRef<const gmx::RVec>   x);
 474
 475 #endif // GMX_NBNXN_NBNXM_H