972c1c7d57c7541257f29446850bdb8acd12d9d2
[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/devicebuffer_datatype.h"
52 #include "gromacs/gpu_utils/gpueventsynchronizer.cuh"
53 #include "gromacs/utility/gmxmpi.h"
54
55 namespace gmx
56 {
57
58 /*! \brief Create PME-PP GPU communication object */
59 PmeForceSenderGpu::Impl::Impl(const DeviceStream& pmeStream, MPI_Comm comm, gmx::ArrayRef<PpRanks> ppRanks) :
60     pmeStream_(pmeStream),
61     comm_(comm),
62     ppRanks_(ppRanks)
63 {
64     GMX_RELEASE_ASSERT(
65             GMX_THREAD_MPI,
66             "PME-PP GPU Communication is currently only supported with thread-MPI enabled");
67 }
68
69 PmeForceSenderGpu::Impl::~Impl() = default;
70
71 /*! \brief  sends force buffer address to PP ranks */
72 void PmeForceSenderGpu::Impl::sendForceBufferAddressToPpRanks(DeviceBuffer<RVec> d_f)
73 {
74     int ind_start = 0;
75     int ind_end   = 0;
76     for (const auto& receiver : ppRanks_)
77     {
78         ind_start = ind_end;
79         ind_end   = ind_start + receiver.numAtoms;
80
81         // Data will be transferred directly from GPU.
82         void* sendBuf = reinterpret_cast<void*>(&d_f[ind_start]);
83
84 #if GMX_MPI
85         MPI_Send(&sendBuf, sizeof(void**), MPI_BYTE, receiver.rankId, 0, comm_);
86 #else
87         GMX_UNUSED_VALUE(sendBuf);
88 #endif
89     }
90 }
91
92 /*! \brief Send PME data directly using CUDA memory copy */
93 void PmeForceSenderGpu::Impl::sendFToPpCudaDirect(int ppRank)
94 {
95     // Data will be pulled directly from PP task
96
97     // Record and send event to ensure PME force calcs are completed before PP task pulls data
98     pmeSync_.markEvent(pmeStream_);
99     GpuEventSynchronizer* pmeSyncPtr = &pmeSync_;
100 #if GMX_MPI
101     // TODO Using MPI_Isend would be more efficient, particularly when
102     // sending to multiple PP ranks
103     MPI_Send(&pmeSyncPtr, sizeof(GpuEventSynchronizer*), MPI_BYTE, ppRank, 0, comm_);
104 #else
105     GMX_UNUSED_VALUE(pmeSyncPtr);
106     GMX_UNUSED_VALUE(ppRank);
107 #endif
108 }
109
110 PmeForceSenderGpu::PmeForceSenderGpu(const DeviceStream&    pmeStream,
111                                      MPI_Comm               comm,
112                                      gmx::ArrayRef<PpRanks> ppRanks) :
113     impl_(new Impl(pmeStream, comm, ppRanks))
114 {
115 }
116
117 PmeForceSenderGpu::~PmeForceSenderGpu() = default;
118
119 void PmeForceSenderGpu::sendForceBufferAddressToPpRanks(DeviceBuffer<RVec> d_f)
120 {
121     impl_->sendForceBufferAddressToPpRanks(d_f);
122 }
123
124 void PmeForceSenderGpu::sendFToPpCudaDirect(int ppRank)
125 {
126     impl_->sendFToPpCudaDirect(ppRank);
127 }
128
129
130 } // namespace gmx