src/gromacs/ewald/pme_pp_comm_gpu.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 /*! \libinternal \file
  36  * \brief Declaration of GPU PME-PP Communication.
  37  *
  38  * \author Alan Gray <alang@nvidia.com>
  39  * \inlibraryapi
  40  * \ingroup module_ewald
  41  */
  42 #ifndef GMX_PME_PP_COMM_GPU_H
  43 #define GMX_PME_PP_COMM_GPU_H
  44
  45 #include <memory>
  46
  47 #include "gromacs/gpu_utils/devicebuffer_datatype.h"
  48 #include "gromacs/math/vectypes.h"
  49 #include "gromacs/utility/gmxmpi.h"
  50
  51 class DeviceContext;
  52 class DeviceStream;
  53 class GpuEventSynchronizer;
  54
  55 namespace gmx
  56 {
  57
  58 class DeviceStreamManager;
  59
  60 /*! \libinternal
  61
  62  * \brief Manages communication related to GPU buffers between this
  63  * PME rank and its PP rank. */
  64 class PmePpCommGpu
  65 {
  66
  67 public:
  68     /*! \brief Creates PME-PP GPU communication object
  69      * \param[in] comm            Communicator used for simulation
  70      * \param[in] pmeRank         Rank of PME task
  71      * \param[in] deviceContext   GPU context.
  72      * \param[in] deviceStream    GPU stream.
  73      */
  74     PmePpCommGpu(MPI_Comm comm, int pmeRank, const DeviceContext& deviceContext, const DeviceStream& deviceStream);
  75     ~PmePpCommGpu();
  76
  77     /*! \brief Perform steps required when buffer size changes
  78      * \param[in]  size   Number of elements in buffer
  79      */
  80     void reinit(int size);
  81
  82     /*! \brief
  83      * Pull data from PME GPU directly using CUDA Memory copy.
  84      * \param[out] recvPtr  Buffer to receive PME force data
  85      * \param[in] recvSize Number of elements to receive
  86      * \param[in] recvPmeForceToGpu Whether receive is to GPU, otherwise CPU
  87      */
  88     void receiveForceFromPme(RVec* recvPtr, int recvSize, bool recvPmeForceToGpu);
  89
  90     /*! \brief Push coordinates buffer directly to GPU memory on PME task
  91      * \param[in] sendPtr Buffer with coordinate data
  92      * \param[in] sendSize Number of elements to send
  93      * \param[in] coordinatesReadyOnDeviceEvent Event recorded when coordinates are available on device
  94      */
  95     void sendCoordinatesToPmeFromGpu(DeviceBuffer<RVec>    sendPtr,
  96                                      int                   sendSize,
  97                                      GpuEventSynchronizer* coordinatesReadyOnDeviceEvent);
  98
  99     /*! \brief Push coordinates buffer from host memory directly to GPU memory on PME task
 100      * \param[in] sendPtr Buffer with coordinate data
 101      * \param[in] sendSize Number of elements to send
 102      * \param[in] coordinatesReadyOnDeviceEvent Event recorded when coordinates are available on device
 103      */
 104     void sendCoordinatesToPmeFromCpu(RVec*                 sendPtr,
 105                                      int                   sendSize,
 106                                      GpuEventSynchronizer* coordinatesReadyOnDeviceEvent);
 107
 108     /*! \brief
 109      * Return pointer to buffer used for staging PME force on GPU
 110      */
 111     DeviceBuffer<gmx::RVec> getGpuForceStagingPtr();
 112
 113     /*! \brief
 114      * Return pointer to event recorded when forces are ready
 115      */
 116     GpuEventSynchronizer* getForcesReadySynchronizer();
 117
 118 private:
 119     class Impl;
 120     std::unique_ptr<Impl> impl_;
 121 };
 122
 123 } // namespace gmx
 124
 125 #endif