src/gromacs/domdec/gpuhaloexchange.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 /*! \libinternal \file
  36  * \brief Declaration of GPU halo exchange.
  37  *
  38  * \author Alan Gray <alang@nvidia.com>
  39  * \inlibraryapi
  40  * \ingroup module_domdec
  41  */
  42 #ifndef GMX_DOMDEC_GPUHALOEXCHANGE_H
  43 #define GMX_DOMDEC_GPUHALOEXCHANGE_H
  44
  45 #include <memory>
  46
  47 #include "gromacs/gpu_utils/devicebuffer_datatype.h"
  48 #include "gromacs/math/vectypes.h"
  49 #include "gromacs/utility/basedefinitions.h"
  50 #include "gromacs/utility/gmxmpi.h"
  51
  52 struct gmx_domdec_t;
  53 struct gmx_wallcycle;
  54 class DeviceContext;
  55 class DeviceStream;
  56 class GpuEventSynchronizer;
  57
  58 namespace gmx
  59 {
  60
  61 /*! \libinternal
  62  * \brief Manages GPU Halo Exchange object */
  63 class GpuHaloExchange
  64 {
  65
  66 public:
  67     /*! \brief Creates GPU Halo Exchange object.
  68      *
  69      * Coordinate Halo exchange will be performed in \c
  70      * StreamNonLocal, and the \c communicateHaloCoordinates
  71      * method must be called before any subsequent operations that
  72      * access non-local parts of the coordinate buffer (such as
  73      * the non-local non-bonded kernels). It also must be called
  74      * after the local coordinates buffer operations (where the
  75      * coordinates are copied to the device and hence the \c
  76      * coordinatesReadyOnDeviceEvent is recorded). Force Halo exchange
  77      * will be performed in \c streamNonLocal (also potentally
  78      * with buffer clearing in \c streamLocal)and the \c
  79      * communicateHaloForces method must be called after the
  80      * non-local buffer operations, after the local force buffer
  81      * has been copied to the GPU (if CPU forces are present), and
  82      * before the local buffer operations. The force halo exchange
  83      * does not yet support virial steps.
  84      *
  85      * \param [inout] dd                       domdec structure
  86      * \param [in]    dimIndex                 the dimension index for this instance
  87      * \param [in]    mpi_comm_mysim           communicator used for simulation
  88      * \param [in]    deviceContext            GPU device context
  89      * \param [in]    streamLocal              local NB CUDA stream.
  90      * \param [in]    streamNonLocal           non-local NB CUDA stream.
  91      * \param [in]    pulse                    the communication pulse for this instance
  92      * \param [in]    wcycle                   The wallclock counter
  93      */
  94     GpuHaloExchange(gmx_domdec_t*        dd,
  95                     int                  dimIndex,
  96                     MPI_Comm             mpi_comm_mysim,
  97                     const DeviceContext& deviceContext,
  98                     const DeviceStream&  streamLocal,
  99                     const DeviceStream&  streamNonLocal,
 100                     int                  pulse,
 101                     gmx_wallcycle*       wcycle);
 102     ~GpuHaloExchange();
 103     GpuHaloExchange(GpuHaloExchange&& source) noexcept;
 104     GpuHaloExchange& operator=(GpuHaloExchange&& source) noexcept;
 105
 106     /*! \brief
 107      *
 108      * Initialization for GPU halo exchange of coordinates buffer
 109      * \param [in] d_coordinateBuffer   pointer to coordinates buffer in GPU memory
 110      * \param [in] d_forcesBuffer   pointer to coordinates buffer in GPU memory
 111      */
 112     void reinitHalo(DeviceBuffer<RVec> d_coordinateBuffer, DeviceBuffer<RVec> d_forcesBuffer);
 113
 114
 115     /*! \brief GPU halo exchange of coordinates buffer.
 116      *
 117      * Must be called after local setCoordinates (which records an
 118      * event when the coordinate data has been copied to the
 119      * device).
 120      * \param [in] box  Coordinate box (from which shifts will be constructed)
 121      * \param [in] coordinatesReadyOnDeviceEvent event recorded when coordinates have been copied to device
 122      */
 123     void communicateHaloCoordinates(const matrix box, GpuEventSynchronizer* coordinatesReadyOnDeviceEvent);
 124
 125     /*! \brief GPU halo exchange of force buffer.
 126      * \param[in] accumulateForces  True if forces should accumulate, otherwise they are set
 127      */
 128     void communicateHaloForces(bool accumulateForces);
 129
 130     /*! \brief Get the event synchronizer for the forces ready on device.
 131      *  \returns  The event to synchronize the stream that consumes forces on device.
 132      */
 133     GpuEventSynchronizer* getForcesReadyOnDeviceEvent();
 134
 135 private:
 136     class Impl;
 137     std::unique_ptr<Impl> impl_;
 138 };
 139
 140 } // namespace gmx
 141
 142 #endif