src/gromacs/ewald/pme_pp_comm_gpu_impl.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019,2020, 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 class for PME-PP communications
  38  *
  39  * \author Alan Gray <alang@nvidia.com>
  40  *
  41  * \ingroup module_ewald
  42  */
  43 #ifndef GMX_PME_PP_COMM_GPU_IMPL_H
  44 #define GMX_PME_PP_COMM_GPU_IMPL_H
  45
  46 #include "gromacs/ewald/pme_pp_comm_gpu.h"
  47 #include "gromacs/gpu_utils/gpueventsynchronizer.cuh"
  48 #include "gromacs/math/vectypes.h"
  49 #include "gromacs/utility/gmxmpi.h"
  50
  51 namespace gmx
  52 {
  53
  54 /*! \internal \brief Class with interfaces and data for CUDA version of PME-PP Communication */
  55 class PmePpCommGpu::Impl
  56 {
  57
  58 public:
  59     /*! \brief Creates PME-PP GPU communication object.
  60      * \param[in] comm            Communicator used for simulation
  61      * \param[in] pmeRank         Rank of PME task
  62      * \param[in] deviceContext   GPU context.
  63      */
  64     Impl(MPI_Comm comm, int pmeRank, const DeviceContext& deviceContext);
  65     ~Impl();
  66
  67     /*! \brief Perform steps required when buffer size changes
  68      * \param[in]  size   Number of elements in buffer
  69      */
  70     void reinit(int size);
  71
  72     /*! \brief Pull force buffer directly from GPU memory on PME
  73      * rank to either GPU or CPU memory on PP task using CUDA
  74      * Memory copy.
  75      *
  76      * recvPtr should be in GPU or CPU memory if recvPmeForceToGpu
  77      * is true or false, respectively. If receiving to GPU, this
  78      * method should be called before the local GPU buffer
  79      * operations. If receiving to CPU it should be called
  80      * before forces are reduced with the other force
  81      * contributions on the CPU. It will automatically wait for
  82      * remote PME force data to be ready.
  83      *
  84      * \param[out] recvPtr CPU buffer to receive PME force data
  85      * \param[in] recvSize Number of elements to receive
  86      * \param[in] receivePmeForceToGpu Whether receive is to GPU, otherwise CPU
  87      */
  88     void receiveForceFromPmeCudaDirect(void* recvPtr, int recvSize, bool receivePmeForceToGpu);
  89
  90
  91     /*! \brief Push coordinates buffer directly to GPU memory on PME
  92      * task, from either GPU or CPU memory on PP task using CUDA
  93      * Memory copy. sendPtr should be in GPU or CPU memory if
  94      * sendPmeCoordinatesFromGpu is true or false respectively. If
  95      * sending from GPU, this method should be called after the
  96      * local GPU coordinate buffer operations. The remote PME task will
  97      * automatically wait for data to be copied before commencing PME force calculations.
  98      * \param[in] sendPtr Buffer with coordinate data
  99      * \param[in] sendSize Number of elements to send
 100      * \param[in] sendPmeCoordinatesFromGpu Whether send is from GPU, otherwise CPU
 101      * \param[in] coordinatesReadyOnDeviceEvent Event recorded when coordinates are available on device
 102      */
 103     void sendCoordinatesToPmeCudaDirect(void*                 sendPtr,
 104                                         int                   sendSize,
 105                                         bool                  sendPmeCoordinatesFromGpu,
 106                                         GpuEventSynchronizer* coordinatesReadyOnDeviceEvent);
 107
 108     /*! \brief
 109      * Return pointer to buffer used for staging PME force on GPU
 110      */
 111     void* getGpuForceStagingPtr();
 112
 113     /*! \brief
 114      * Return pointer to event recorded when forces are ready
 115      */
 116     void* getForcesReadySynchronizer();
 117
 118 private:
 119     //! Device context object
 120     const DeviceContext& deviceContext_;
 121     //! CUDA stream used for the communication operations in this class
 122     DeviceStream pmePpCommStream_;
 123     //! Remote location of PME coordinate data buffer
 124     void* remotePmeXBuffer_ = nullptr;
 125     //! Remote location of PME force data buffer
 126     void* remotePmeFBuffer_ = nullptr;
 127     //! communicator for simulation
 128     MPI_Comm comm_;
 129     //! Rank of PME task
 130     int pmeRank_ = -1;
 131     //! Buffer for staging PME force on GPU
 132     rvec* d_pmeForces_ = nullptr;
 133     //! number of atoms in PME force staging array
 134     int d_pmeForcesSize_ = -1;
 135     //! number of atoms allocated in recvbuf array
 136     int d_pmeForcesSizeAlloc_ = -1;
 137     //! Event recorded when PME forces are ready on PME task
 138     GpuEventSynchronizer forcesReadySynchronizer_;
 139     //! Event recorded when coordinates have been transferred to PME task
 140     GpuEventSynchronizer pmeCoordinatesSynchronizer_;
 141 };
 142
 143 } // namespace gmx
 144
 145 #endif