src/gromacs/listed_forces/gpubonded_impl.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019,2020,2021, 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 /*! \internal \file
  36  * \brief Declares GPU implementation class for CUDA bonded
  37  * interactions.
  38  *
  39  * This header file is needed to include from both the device-side
  40  * kernels file, and the host-side management code.
  41  *
  42  * \author Berk Hess <hess@kth.se>
  43  * \author Szilárd Páll <pall.szilard@gmail.com>
  44  * \author Mark Abraham <mark.j.abraham@gmail.com>
  45  *
  46  * \ingroup module_listed_forces
  47  */
  48 #ifndef GMX_LISTED_FORCES_GPUBONDED_IMPL_H
  49 #define GMX_LISTED_FORCES_GPUBONDED_IMPL_H
  50
  51 #include "gromacs/gpu_utils/device_context.h"
  52 #include "gromacs/gpu_utils/gputraits.cuh"
  53 #include "gromacs/gpu_utils/hostallocator.h"
  54 #include "gromacs/listed_forces/gpubonded.h"
  55 #include "gromacs/pbcutil/pbc_aiuc.h"
  56
  57 struct gmx_ffparams_t;
  58 struct t_forcerec;
  59
  60 namespace gmx
  61 {
  62
  63 /*! \internal \brief Version of InteractionList that supports pinning */
  64 struct HostInteractionList
  65 {
  66     /*! \brief Returns the total number of elements in iatoms */
  67     int size() const { return iatoms.size(); }
  68
  69     //! List of interactions, see \c HostInteractionLists
  70     HostVector<int> iatoms = { {}, gmx::HostAllocationPolicy(gmx::PinningPolicy::PinnedIfSupported) };
  71 };
  72
  73 /* \brief Bonded parameters and GPU pointers
  74  *
  75  * This is used to accumulate all the parameters and pointers so they can be passed
  76  * to the GPU as a single structure.
  77  *
  78  */
  79 struct BondedCudaKernelParameters
  80 {
  81     //! Periodic boundary data
  82     PbcAiuc pbcAiuc;
  83     //! Scale factor
  84     float electrostaticsScaleFactor;
  85     //! The bonded types on GPU
  86     int fTypesOnGpu[numFTypesOnGpu];
  87     //! The number of interaction atom (iatom) elements for every function type
  88     int numFTypeIAtoms[numFTypesOnGpu];
  89     //! The number of bonds for every function type
  90     int numFTypeBonds[numFTypesOnGpu];
  91     //! The start index in the range of each interaction type
  92     int fTypeRangeStart[numFTypesOnGpu];
  93     //! The end index in the range of each interaction type
  94     int fTypeRangeEnd[numFTypesOnGpu];
  95
  96     //! Force parameters (on GPU)
  97     t_iparams* d_forceParams;
  98     //! Coordinates before the timestep (on GPU)
  99     const float4* d_xq;
 100     //! Forces on atoms (on GPU)
 101     float3* d_f;
 102     //! Force shifts on atoms (on GPU)
 103     float3* d_fShift;
 104     //! Total Energy (on GPU)
 105     float* d_vTot;
 106     //! Interaction list atoms (on GPU)
 107     t_iatom* d_iatoms[numFTypesOnGpu];
 108
 109     BondedCudaKernelParameters()
 110     {
 111         matrix boxDummy = { { 0, 0, 0 }, { 0, 0, 0 }, { 0, 0, 0 } };
 112
 113         setPbcAiuc(0, boxDummy, &pbcAiuc);
 114
 115         electrostaticsScaleFactor = 1.0;
 116         d_forceParams             = nullptr;
 117         d_xq                      = nullptr;
 118         d_f                       = nullptr;
 119         d_fShift                  = nullptr;
 120         d_vTot                    = nullptr;
 121     }
 122 };
 123
 124 /*! \internal \brief Implements GPU bondeds */
 125 class GpuBonded::Impl
 126 {
 127 public:
 128     //! Constructor
 129     Impl(const gmx_ffparams_t& ffparams,
 130          float                 electrostaticsScaleFactor,
 131          const DeviceContext&  deviceContext,
 132          const DeviceStream&   deviceStream,
 133          gmx_wallcycle*        wcycle);
 134     /*! \brief Destructor, non-default needed for freeing
 135      * device-side buffers */
 136     ~Impl();
 137     /*! \brief Update lists of interactions from idef suitable for the GPU,
 138      * using the data structures prepared for PP work.
 139      *
 140      * Intended to be called after each neighbour search
 141      * stage. Copies the bonded interactions assigned to the GPU
 142      * to device data structures, and updates device buffers that
 143      * may have been updated after search. */
 144     void updateInteractionListsAndDeviceBuffers(ArrayRef<const int>           nbnxnAtomOrder,
 145                                                 const InteractionDefinitions& idef,
 146                                                 void*                         xqDevice,
 147                                                 DeviceBuffer<RVec>            forceDevice,
 148                                                 DeviceBuffer<RVec>            fshiftDevice);
 149     /*! \brief
 150      * Update PBC data.
 151      *
 152      * Converts PBC data from t_pbc into the PbcAiuc format and stores the latter.
 153      *
 154      * \param[in] pbcType The type of the periodic boundary.
 155      * \param[in] box     The periodic boundary box matrix.
 156      * \param[in] canMoleculeSpanPbc  Whether one molecule can have atoms in different PBC cells.
 157      */
 158     void setPbc(PbcType pbcType, const matrix box, bool canMoleculeSpanPbc);
 159
 160     /*! \brief Launches bonded kernel on a GPU */
 161     template<bool calcVir, bool calcEner>
 162     void launchKernel();
 163     /*! \brief Returns whether there are bonded interactions
 164      * assigned to the GPU */
 165     bool haveInteractions() const;
 166     /*! \brief Launches the transfer of computed bonded energies. */
 167     void launchEnergyTransfer();
 168     /*! \brief Waits on the energy transfer, and accumulates bonded energies to \c enerd. */
 169     void waitAccumulateEnergyTerms(gmx_enerdata_t* enerd);
 170     /*! \brief Clears the device side energy buffer */
 171     void clearEnergies();
 172
 173 private:
 174     /*! \brief The interaction lists
 175      *
 176      * \todo This is potentially several pinned allocations, which
 177      * could contribute to exhausting such pages. */
 178     std::array<HostInteractionList, F_NRE> iLists_;
 179
 180     //! Tells whether there are any interaction in iLists.
 181     bool haveInteractions_;
 182     //! Interaction lists on the device.
 183     t_ilist d_iLists_[F_NRE] = {};
 184     //! Bonded parameters for device-side use.
 185     t_iparams* d_forceParams_ = nullptr;
 186     //! Position-charge vector on the device.
 187     const float4* d_xq_ = nullptr;
 188     //! Force vector on the device.
 189     float3* d_f_ = nullptr;
 190     //! Shift force vector on the device.
 191     float3* d_fShift_ = nullptr;
 192     //! \brief Host-side virial buffer
 193     HostVector<float> vTot_ = { {}, gmx::HostAllocationPolicy(gmx::PinningPolicy::PinnedIfSupported) };
 194     //! \brief Device-side total virial
 195     float* d_vTot_ = nullptr;
 196
 197     //! GPU context object
 198     const DeviceContext& deviceContext_;
 199     //! \brief Bonded GPU stream, not owned by this module
 200     const DeviceStream& deviceStream_;
 201
 202     //! Parameters and pointers, passed to the CUDA kernel
 203     BondedCudaKernelParameters kernelParams_;
 204
 205     //! GPU kernel launch configuration
 206     KernelLaunchConfig kernelLaunchConfig_;
 207
 208     //! \brief Pointer to wallcycle structure.
 209     gmx_wallcycle* wcycle_;
 210 };
 211
 212 } // namespace gmx
 213
 214 #endif