src/gromacs/ewald/pme_coordinate_receiver_gpu_impl.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 /*! \internal \file
  36  *
  37  * \brief Declaration of class which receives coordinates to GPU memory on PME task
  38  *
  39  * \author Alan Gray <alang@nvidia.com>
  40  *
  41  * \ingroup module_ewald
  42  */
  43 #ifndef GMX_PMECOORDINATERECEIVERGPU_IMPL_H
  44 #define GMX_PMECOORDINATERECEIVERGPU_IMPL_H
  45
  46 #include <vector>
  47
  48 #include "gromacs/ewald/pme_coordinate_receiver_gpu.h"
  49 #include "gromacs/utility/arrayref.h"
  50
  51 class GpuEventSynchronizer;
  52
  53 namespace gmx
  54 {
  55 /*! \internal \brief Class with interfaces and data for CUDA version of PME coordinate receiving functionality */
  56
  57 class PmeCoordinateReceiverGpu::Impl
  58 {
  59
  60 public:
  61     /*! \brief Creates PME GPU coordinate receiver object
  62      * \param[in] pmeStream       CUDA stream used for PME computations
  63      * \param[in] comm            Communicator used for simulation
  64      * \param[in] ppRanks         List of PP ranks
  65      */
  66     Impl(const DeviceStream& pmeStream, MPI_Comm comm, gmx::ArrayRef<PpRanks> ppRanks);
  67     ~Impl();
  68
  69     /*! \brief
  70      * send coordinates buffer address to PP rank
  71      * \param[in] d_x   coordinates buffer in GPU memory
  72      */
  73     void sendCoordinateBufferAddressToPpRanks(DeviceBuffer<RVec> d_x);
  74
  75     /*! \brief
  76      * Receive coordinate synchronizer pointer from the PP ranks.
  77      * \param[in] ppRank  PP rank to receive the synchronizer from.
  78      */
  79     void receiveCoordinatesSynchronizerFromPpCudaDirect(int ppRank);
  80
  81     /*! \brief
  82      * Used for lib MPI, receives co-ordinates from PP ranks
  83      * \param[in] recvbuf   coordinates buffer in GPU memory
  84      * \param[in] numAtoms  starting element in buffer
  85      * \param[in] numBytes  number of bytes to transfer
  86      * \param[in] ppRank    PP rank to send data
  87      */
  88     void launchReceiveCoordinatesFromPpCudaMpi(DeviceBuffer<RVec> recvbuf, int numAtoms, int numBytes, int ppRank);
  89
  90     /*! \brief
  91      * For lib MPI, wait for coordinates from PP ranks
  92      * For thread MPI, enqueue PP co-ordinate transfer event into PME stream
  93      */
  94     void synchronizeOnCoordinatesFromPpRanks();
  95
  96 private:
  97     //! CUDA stream for PME operations
  98     const DeviceStream& pmeStream_;
  99     //! communicator for simulation
 100     MPI_Comm comm_;
 101     //! list of PP ranks
 102     gmx::ArrayRef<PpRanks> ppRanks_;
 103     //! vector of MPI requests
 104     std::vector<MPI_Request> request_;
 105     //! vector of synchronization events to receive from PP tasks
 106     std::vector<GpuEventSynchronizer*> ppSync_;
 107     //! counter of messages to receive
 108     int recvCount_ = 0;
 109 };
 110
 111 } // namespace gmx
 112
 113 #endif