ecec4d6ac6fd42b19ac574aa7db555b74baf3856
[alexxy/gromacs.git] / src / gromacs / ewald / pme_force_sender_gpu_impl.cu
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 Implements PME-PP communication using CUDA
38  *
39  *
40  * \author Alan Gray <alang@nvidia.com>
41  *
42  * \ingroup module_ewald
43  */
44 #include "gmxpre.h"
45
46 #include "pme_force_sender_gpu_impl.h"
47
48 #include "config.h"
49
50 #include "gromacs/gpu_utils/cudautils.cuh"
51 #include "gromacs/gpu_utils/gpueventsynchronizer.cuh"
52 #include "gromacs/utility/gmxmpi.h"
53
54 namespace gmx
55 {
56
57 /*! \brief Create PME-PP GPU communication object */
58 PmeForceSenderGpu::Impl::Impl(GpuEventSynchronizer*  pmeForcesReady,
59                               MPI_Comm               comm,
60                               gmx::ArrayRef<PpRanks> ppRanks) :
61     pmeForcesReady_(pmeForcesReady), comm_(comm), ppRanks_(ppRanks)
62 {
63 }
64
65 PmeForceSenderGpu::Impl::~Impl() = default;
66
67 /*! \brief  sends force buffer address to PP ranks */
68 void PmeForceSenderGpu::Impl::sendForceBufferAddressToPpRanks(DeviceBuffer<Float3> d_f)
69 {
70     // Need to send address to PP rank only for thread-MPI as PP rank pulls
71     // data using cudamemcpy
72     if (!GMX_THREAD_MPI)
73     {
74         return;
75     }
76 #if GMX_MPI
77     int ind_start = 0;
78     int ind_end   = 0;
79     for (const auto& receiver : ppRanks_)
80     {
81         ind_start = ind_end;
82         ind_end   = ind_start + receiver.numAtoms;
83
84         // Data will be transferred directly from GPU.
85         Float3* sendBuf = &d_f[ind_start];
86
87         MPI_Send(&sendBuf, sizeof(Float3*), MPI_BYTE, receiver.rankId, 0, comm_);
88     }
89 #else
90     GMX_UNUSED_VALUE(d_f);
91 #endif
92 }
93
94 /*! \brief Send PME synchronizer directly using CUDA memory copy */
95 void PmeForceSenderGpu::Impl::sendFSynchronizerToPpCudaDirect(int ppRank)
96 {
97     GMX_ASSERT(GMX_THREAD_MPI,
98                "sendFSynchronizerToPpCudaDirect is expected to be called only for Thread-MPI");
99
100     // Data will be pulled directly from PP task
101 #if GMX_MPI
102     // TODO Using MPI_Isend would be more efficient, particularly when
103     // sending to multiple PP ranks
104     MPI_Send(&pmeForcesReady_, sizeof(GpuEventSynchronizer*), MPI_BYTE, ppRank, 0, comm_);
105 #else
106     GMX_UNUSED_VALUE(ppRank);
107 #endif
108 }
109
110 /*! \brief Send PME data directly using CUDA-aware MPI */
111 void PmeForceSenderGpu::Impl::sendFToPpCudaMpi(DeviceBuffer<RVec> sendbuf,
112                                                int                offset,
113                                                int                numBytes,
114                                                int                ppRank,
115                                                MPI_Request*       request)
116 {
117     GMX_ASSERT(GMX_LIB_MPI, "sendFToPpCudaMpi is expected to be called only for Lib-MPI");
118
119 #if GMX_MPI
120     // if using GPU direct comm with CUDA-aware MPI, make sure forces are ready on device
121     // before sending it to PP ranks
122     pmeForcesReady_->waitForEvent();
123
124     MPI_Isend(sendbuf[offset], numBytes, MPI_BYTE, ppRank, 0, comm_, request);
125
126 #else
127     GMX_UNUSED_VALUE(sendbuf);
128     GMX_UNUSED_VALUE(offset);
129     GMX_UNUSED_VALUE(numBytes);
130     GMX_UNUSED_VALUE(ppRank);
131     GMX_UNUSED_VALUE(request);
132 #endif
133 }
134
135 PmeForceSenderGpu::PmeForceSenderGpu(GpuEventSynchronizer*  pmeForcesReady,
136                                      MPI_Comm               comm,
137                                      gmx::ArrayRef<PpRanks> ppRanks) :
138     impl_(new Impl(pmeForcesReady, comm, ppRanks))
139 {
140 }
141
142 PmeForceSenderGpu::~PmeForceSenderGpu() = default;
143
144 void PmeForceSenderGpu::sendForceBufferAddressToPpRanks(DeviceBuffer<RVec> d_f)
145 {
146     impl_->sendForceBufferAddressToPpRanks(d_f);
147 }
148
149 void PmeForceSenderGpu::sendFSynchronizerToPpCudaDirect(int ppRank)
150 {
151     impl_->sendFSynchronizerToPpCudaDirect(ppRank);
152 }
153
154 void PmeForceSenderGpu::sendFToPpCudaMpi(DeviceBuffer<RVec> sendbuf,
155                                          int                offset,
156                                          int                numBytes,
157                                          int                ppRank,
158                                          MPI_Request*       request)
159 {
160     impl_->sendFToPpCudaMpi(sendbuf, offset, numBytes, ppRank, request);
161 }
162
163
164 } // namespace gmx