Clean up ewald module internals
[alexxy/gromacs.git] / src / gromacs / ewald / pme_coordinate_receiver_gpu_impl.cu
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 Implements class which recieves coordinates to GPU memory on PME task 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_coordinate_receiver_gpu_impl.h"
47
48 #include "config.h"
49
50 #include "gromacs/ewald/pme_force_sender_gpu.h"
51 #include "gromacs/gpu_utils/cudautils.cuh"
52 #include "gromacs/gpu_utils/gpueventsynchronizer.cuh"
53 #include "gromacs/utility/gmxmpi.h"
54
55 namespace gmx
56 {
57
58 PmeCoordinateReceiverGpu::Impl::Impl(void* pmeStream, MPI_Comm comm, gmx::ArrayRef<PpRanks> ppRanks) :
59     pmeStream_(*static_cast<cudaStream_t*>(pmeStream)),
60     comm_(comm),
61     ppRanks_(ppRanks)
62 {
63     GMX_RELEASE_ASSERT(
64             GMX_THREAD_MPI,
65             "PME-PP GPU Communication is currently only supported with thread-MPI enabled");
66     request_.resize(ppRanks.size());
67     ppSync_.resize(ppRanks.size());
68 }
69
70 PmeCoordinateReceiverGpu::Impl::~Impl() = default;
71
72 void PmeCoordinateReceiverGpu::Impl::sendCoordinateBufferAddressToPpRanks(DeviceBuffer<float> d_x)
73 {
74
75     int ind_start = 0;
76     int ind_end   = 0;
77     for (const auto& receiver : ppRanks_)
78     {
79         ind_start = ind_end;
80         ind_end   = ind_start + receiver.numAtoms;
81
82         // Data will be transferred directly from GPU.
83         void* sendBuf = reinterpret_cast<void*>(&d_x[ind_start * DIM]);
84
85 #if GMX_MPI
86         MPI_Send(&sendBuf, sizeof(void**), MPI_BYTE, receiver.rankId, 0, comm_);
87 #else
88         GMX_UNUSED_VALUE(sendBuf);
89 #endif
90     }
91 }
92
93 /*! \brief Receive coordinate data directly using CUDA memory copy */
94 void PmeCoordinateReceiverGpu::Impl::launchReceiveCoordinatesFromPpCudaDirect(int ppRank)
95 {
96     // Data will be pushed directly from PP task
97
98 #if GMX_MPI
99     // Receive event from PP task
100     MPI_Irecv(&ppSync_[recvCount_], sizeof(GpuEventSynchronizer*), MPI_BYTE, ppRank, 0, comm_,
101               &request_[recvCount_]);
102     recvCount_++;
103 #else
104     GMX_UNUSED_VALUE(ppRank);
105 #endif
106 }
107
108 void PmeCoordinateReceiverGpu::Impl::enqueueWaitReceiveCoordinatesFromPpCudaDirect()
109 {
110     if (recvCount_ > 0)
111     {
112         // ensure PME calculation doesn't commence until coordinate data has been transferred
113 #if GMX_MPI
114         MPI_Waitall(recvCount_, request_.data(), MPI_STATUS_IGNORE);
115 #endif
116         for (int i = 0; i < recvCount_; i++)
117         {
118             ppSync_[i]->enqueueWaitEvent(pmeStream_);
119         }
120         // reset receive counter
121         recvCount_ = 0;
122     }
123 }
124
125 PmeCoordinateReceiverGpu::PmeCoordinateReceiverGpu(void*                  pmeStream,
126                                                    MPI_Comm               comm,
127                                                    gmx::ArrayRef<PpRanks> ppRanks) :
128     impl_(new Impl(pmeStream, comm, ppRanks))
129 {
130 }
131
132 PmeCoordinateReceiverGpu::~PmeCoordinateReceiverGpu() = default;
133
134 void PmeCoordinateReceiverGpu::sendCoordinateBufferAddressToPpRanks(DeviceBuffer<float> d_x)
135 {
136     impl_->sendCoordinateBufferAddressToPpRanks(d_x);
137 }
138
139 void PmeCoordinateReceiverGpu::launchReceiveCoordinatesFromPpCudaDirect(int ppRank)
140 {
141     impl_->launchReceiveCoordinatesFromPpCudaDirect(ppRank);
142 }
143
144 void PmeCoordinateReceiverGpu::enqueueWaitReceiveCoordinatesFromPpCudaDirect()
145 {
146     impl_->enqueueWaitReceiveCoordinatesFromPpCudaDirect();
147 }
148
149 } // namespace gmx