src/gromacs/domdec/gpuhaloexchange_impl.cuh

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019, 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  *
  37  * \brief Declares CUDA implementation of GPU Halo Exchange.
  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 Alan Gray <alang@nvidia.com>
  43  *
  44  * \ingroup module_domdec
  45  */
  46 #ifndef GMX_DOMDEC_GPUHALOEXCHANGE_IMPL_H
  47 #define GMX_DOMDEC_GPUHALOEXCHANGE_IMPL_H
  48
  49 #include "gromacs/domdec/gpuhaloexchange.h"
  50 #include "gromacs/gpu_utils/gpueventsynchronizer.cuh"
  51 #include "gromacs/gpu_utils/hostallocator.h"
  52 #include "gromacs/utility/gmxmpi.h"
  53
  54 namespace gmx
  55 {
  56
  57 /*! \brief switch for whether coordinates or force halo is being applied */
  58 enum class HaloQuantity
  59 {
  60     HaloCoordinates,
  61     HaloForces
  62 };
  63
  64 /*! \internal \brief Class with interfaces and data for GPU Halo Exchange */
  65 class GpuHaloExchange::Impl
  66 {
  67
  68 public:
  69     /*! \brief Creates GPU Halo Exchange object.
  70      *
  71      * \param [inout] dd                       domdec structure
  72      * \param [in]    mpi_comm_mysim           communicator used for simulation
  73      * \param [in]    localStream              local NB CUDA stream
  74      * \param [in]    nonLocalStream           non-local NB CUDA stream
  75      */
  76     Impl(gmx_domdec_t* dd, MPI_Comm mpi_comm_mysim, void* localStream, void* nonLocalStream);
  77     ~Impl();
  78
  79     /*! \brief
  80      * (Re-) Initialization for GPU halo exchange
  81      * \param [in] d_coordinatesBuffer  pointer to coordinates buffer in GPU memory
  82      * \param [in] d_forcesBuffer   pointer to forces buffer in GPU memory
  83      */
  84     void reinitHalo(float3* d_coordinatesBuffer, float3* d_forcesBuffer);
  85
  86
  87     /*! \brief
  88      * GPU halo exchange of coordinates buffer
  89      * \param [in] box  Coordinate box (from which shifts will be constructed)
  90      * \param [in] coordinatesReadyOnDeviceEvent event recorded when coordinates have been copied to device
  91      */
  92     void communicateHaloCoordinates(const matrix box, GpuEventSynchronizer* coordinatesReadyOnDeviceEvent);
  93
  94     /*! \brief  GPU halo exchange of force buffer
  95      * \param[in] accumulateForces  True if forces should accumulate, otherwise they are set
  96      */
  97     void communicateHaloForces(bool accumulateForces);
  98
  99     /*! \brief Get the event synchronizer for the forces ready on device.
 100      *  \returns  The event to synchronize the stream that consumes forces on device.
 101      */
 102     GpuEventSynchronizer* getForcesReadyOnDeviceEvent();
 103
 104 private:
 105     /*! \brief Data transfer wrapper for GPU halo exchange
 106      * \param [inout] d_ptr      pointer to coordinates or force buffer in GPU memory
 107      * \param [in] haloQuantity  switch on whether X or F halo exchange is being performed
 108      * \param [in] coordinatesReadyOnDeviceEvent event recorded when coordinates have been copied to device
 109      */
 110     void communicateHaloData(float3*               d_ptr,
 111                              HaloQuantity          haloQuantity,
 112                              GpuEventSynchronizer* coordinatesReadyOnDeviceEvent);
 113
 114     /*! \brief Data transfer for GPU halo exchange using CUDA memcopies
 115      * \param [inout] sendPtr    address to send data from
 116      * \param [in] sendSize      number of atoms to be sent
 117      * \param [in] sendRank      rank to send data to
 118      * \param [inout] remotePtr  remote address to recv data
 119      * \param [in] recvRank      rank to recv data from
 120      */
 121     void communicateHaloDataWithCudaDirect(void* sendPtr, int sendSize, int sendRank, void* remotePtr, int recvRank);
 122
 123     //! Domain decomposition object
 124     gmx_domdec_t* dd_ = nullptr;
 125     //! map of indices to be sent from this rank
 126     gmx::HostVector<int> h_indexMap_;
 127     //! device copy of index map
 128     int* d_indexMap_ = nullptr;
 129     //! number of elements in index map array
 130     int indexMapSize_ = -1;
 131     //! number of elements allocated in index map array
 132     int indexMapSizeAlloc_ = -1;
 133     //! device buffer for sending packed data
 134     float3* d_sendBuf_ = nullptr;
 135     //! number of atoms in sendbuf array
 136     int sendBufSize_ = -1;
 137     //! number of atoms allocated in sendbuf array
 138     int sendBufSizeAlloc_ = -1;
 139     //! device buffer for receiving packed data
 140     float3* d_recvBuf_ = nullptr;
 141     //! maximum size of packed buffer
 142     int maxPackedBufferSize_ = 0;
 143     //! number of atoms in recvbuf array
 144     int recvBufSize_ = -1;
 145     //! number of atoms allocated in recvbuf array
 146     int recvBufSizeAlloc_ = -1;
 147     //! rank to send data to for X
 148     int sendRankX_ = 0;
 149     //! rank to recv data from for X
 150     int recvRankX_ = 0;
 151     //! rank to send data to for F
 152     int sendRankF_ = 0;
 153     //! rank to recv data from for F
 154     int recvRankF_ = 0;
 155     //! send copy size from this rank for X
 156     int xSendSize_ = 0;
 157     //! recv copy size to this rank for X
 158     int xRecvSize_ = 0;
 159     //! send copy size from this rank for F
 160     int fSendSize_ = 0;
 161     //! recv copy size to this rank for F
 162     int fRecvSize_ = 0;
 163     //! number of home atoms - offset of local halo region
 164     int numHomeAtoms_ = 0;
 165     //! remote GPU coordinates buffer pointer for pushing data
 166     void* remoteXPtr_ = nullptr;
 167     //! remote GPU force buffer pointer for pushing data
 168     void* remoteFPtr_ = nullptr;
 169     //! Periodic Boundary Conditions for this rank
 170     bool usePBC_ = false;
 171     //! force shift buffer on device
 172     float3* d_fShift_ = nullptr;
 173     //! Event triggered when halo transfer has been launched with direct CUD memory copy
 174     GpuEventSynchronizer* haloDataTransferLaunched_ = nullptr;
 175     //! MPI communicator used for simulation
 176     MPI_Comm mpi_comm_mysim_;
 177     //! CUDA stream for local non-bonded calculations
 178     cudaStream_t localStream_ = nullptr;
 179     //! CUDA stream for non-local non-bonded calculations
 180     cudaStream_t nonLocalStream_ = nullptr;
 181     //! full coordinates buffer in GPU memory
 182     float3* d_x_ = nullptr;
 183     //! full forces buffer in GPU memory
 184     float3* d_f_ = nullptr;
 185     //! An event recorded once the exchanged forces are ready on the GPU
 186     GpuEventSynchronizer fReadyOnDevice_;
 187 };
 188
 189 } // namespace gmx
 190
 191 #endif