src/gromacs/mdtypes/state_propagator_data_gpu.h

   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 Declaration of interfaces for GPU state data propagator object.
  38  *
  39  * This object stores and manages positions, velocities and forces for
  40  * all particles in the system on the GPU.
  41  *
  42  * \todo Add cycle counters.
  43  * \todo Add synchronization points.
  44  *
  45  * \author Artem Zhmurov <zhmurov@gmail.com>
  46  *
  47  * \inlibraryapi
  48  * \ingroup module_mdtypes
  49  */
  50 #ifndef GMX_MDTYPES_STATE_PROPAGATOR_DATA_GPU_H
  51 #define GMX_MDTYPES_STATE_PROPAGATOR_DATA_GPU_H
  52
  53 #include <tuple>
  54
  55 #include "gromacs/gpu_utils/devicebuffer_datatype.h"
  56 #include "gromacs/gpu_utils/gpu_utils.h"
  57 #include "gromacs/math/vectypes.h"
  58 #include "gromacs/mdtypes/simulation_workload.h"
  59 #include "gromacs/utility/arrayref.h"
  60 #include "gromacs/utility/classhelpers.h"
  61
  62 #include "locality.h"
  63
  64 class DeviceContext;
  65 class DeviceStream;
  66 class GpuEventSynchronizer;
  67 struct gmx_wallcycle;
  68
  69 namespace gmx
  70 {
  71 class DeviceStreamManager;
  72
  73 class StatePropagatorDataGpu
  74 {
  75 public:
  76     /*! \brief Constructor
  77      *
  78      * The buffers are reallocated only at the reinit call, the padding is
  79      * used there for the coordinates buffer. It is needed for PME and added at
  80      * the end of the buffer. It is assumed that if the rank has PME duties on the
  81      * GPU, all coordinates are copied to the GPU and hence, for this rank, the
  82      * coordinates buffer is not split into local and non-local ranges. For other
  83      * ranks, the padding size is zero. This works because only one rank ever does
  84      * PME work on the GPU, and if that rank also does PP work that is the only
  85      * rank. So all coordinates are always transferred.
  86      *
  87      * In OpenCL, only pmeStream is used since it is the only stream created in
  88      * PME context. The local and non-local streams are only needed when buffer
  89      * ops are offloaded. This feature is currently not available in OpenCL and
  90      * hence these streams are not set in these builds.
  91      *
  92      *  \param[in] deviceStreamManager         Object that owns the DeviceContext and DeviceStreams.
  93      *  \param[in] transferKind                H2D/D2H transfer call behavior (synchronous or not).
  94      *  \param[in] allocationBlockSizeDivisor  Deterines padding size for coordinates buffer.
  95      *  \param[in] wcycle                      Wall cycle counter data.
  96      */
  97     StatePropagatorDataGpu(const DeviceStreamManager& deviceStreamManager,
  98                            GpuApiCallBehavior         transferKind,
  99                            int                        allocationBlockSizeDivisor,
 100                            gmx_wallcycle*             wcycle);
 101
 102     /*! \brief Constructor to use in PME-only rank and in tests.
 103      *
 104      *  This constructor should be used if only a coordinate device buffer should be managed
 105      *  using a single stream. Any operation on force or velocity buffer as well as copy of
 106      *  non-local coordinates will exit with assertion failure. Note, that the pmeStream can
 107      *  not be a nullptr and the constructor will exit with an assertion failure.
 108      *
 109      *  \todo Currently, unsupported copy operations are blocked by assertion that the stream
 110      *        not nullptr. This should be improved.
 111      *
 112      *  \param[in] pmeStream       Device PME stream, nullptr is not allowed.
 113      *  \param[in] deviceContext   Device context, nullptr allowed for non-OpenCL builds.
 114      *  \param[in] transferKind    H2D/D2H transfer call behavior (synchronous or not).
 115      *  \param[in] allocationBlockSizeDivisor Determines padding size for coordinates buffer.
 116      *  \param[in] wcycle          Wall cycle counter data.
 117      */
 118     StatePropagatorDataGpu(const DeviceStream*  pmeStream,
 119                            const DeviceContext& deviceContext,
 120                            GpuApiCallBehavior   transferKind,
 121                            int                  allocationBlockSizeDivisor,
 122                            gmx_wallcycle*       wcycle);
 123
 124     //! Move constructor
 125     StatePropagatorDataGpu(StatePropagatorDataGpu&& other) noexcept;
 126     //! Move assignment
 127     StatePropagatorDataGpu& operator=(StatePropagatorDataGpu&& other) noexcept;
 128     //! Destructor
 129     ~StatePropagatorDataGpu();
 130
 131     /*! \brief Set the ranges for local and non-local atoms and reallocates buffers.
 132      *
 133      * Reallocates coordinate, velocities and force buffers on the device.
 134      *
 135      * \note
 136      * The coordinates buffer is (re)allocated, when required by PME, with a padding,
 137      * the size of which is set by the constructor. The padding region clearing kernel
 138      * is scheduled in the \p pmeStream_ (unlike the coordinates H2D) as only the PME
 139      * task uses this padding area.
 140      *
 141      * \note
 142      * The force buffer is cleared if its size increases, so that previously unused
 143      * memory is cleared before forces are accumulated.
 144      *
 145      *  \param[in] numAtomsLocal  Number of atoms in local domain.
 146      *  \param[in] numAtomsAll    Total number of atoms to handle.
 147      */
 148     void reinit(int numAtomsLocal, int numAtomsAll);
 149
 150     /*! \brief Returns the range of atoms to be copied based on the copy type (all, local or non-local).
 151      *
 152      * \todo There are at least three versions of the function with this functionality in the code:
 153      *       this one and two more in NBNXM. These should be unified in a shape of a general function
 154      *       in DD.
 155      *
 156      * \param[in]  atomLocality    If all, local or non-local ranges are needed.
 157      *
 158      * \returns Tuple, containing the index of the first atom in the range and the total number of atoms in the range.
 159      */
 160     std::tuple<int, int> getAtomRangesFromAtomLocality(AtomLocality atomLocality);
 161
 162
 163     /*! \brief Get the positions buffer on the GPU.
 164      *
 165      *  \returns GPU positions buffer.
 166      */
 167     DeviceBuffer<RVec> getCoordinates();
 168
 169     /*! \brief Copy positions to the GPU memory.
 170      *
 171      *  \param[in] h_x           Positions in the host memory.
 172      *  \param[in] atomLocality  Locality of the particles to copy.
 173      */
 174     void copyCoordinatesToGpu(gmx::ArrayRef<const gmx::RVec> h_x, AtomLocality atomLocality);
 175
 176     /*! \brief Get the event synchronizer of the coordinates ready for the consumption on the device.
 177      *
 178      * Returns the event synchronizer which indicates that the coordinates are ready for the
 179      * consumption on the device. Takes into account that the producer may be different.
 180      *
 181      * If the update is offloaded, and the current step is not a DD/search step, the returned
 182      * synchronizer indicates the completion of GPU update-constraint kernels. Otherwise, on search
 183      * steps and if update is not offloaded, the coordinates are provided by the H2D copy and the
 184      * returned synchronizer indicates that the copy is complete.
 185      *
 186      *  \param[in] atomLocality    Locality of the particles to wait for.
 187      *  \param[in] simulationWork  The simulation lifetime flags.
 188      *  \param[in] stepWork        The step lifetime flags.
 189      *
 190      *  \returns  The event to synchronize the stream that consumes coordinates on device.
 191      */
 192     GpuEventSynchronizer* getCoordinatesReadyOnDeviceEvent(AtomLocality              atomLocality,
 193                                                            const SimulationWorkload& simulationWork,
 194                                                            const StepWorkload&       stepWork);
 195
 196     /*! \brief Blocking wait until coordinates are copied to the device.
 197      *
 198      * Synchronizes the stream in which the copy was executed.
 199      *
 200      *  \param[in] atomLocality  Locality of the particles to wait for.
 201      */
 202     void waitCoordinatesCopiedToDevice(AtomLocality atomLocality);
 203
 204     /*! \brief Getter for the event synchronizer for the update is done on th GPU
 205      *
 206      *  \returns  The event to synchronize the stream coordinates wre updated on device.
 207      */
 208     GpuEventSynchronizer* xUpdatedOnDevice();
 209
 210     /*! \brief Copy positions from the GPU memory.
 211      *
 212      *  \param[in] h_x           Positions buffer in the host memory.
 213      *  \param[in] atomLocality  Locality of the particles to copy.
 214      */
 215     void copyCoordinatesFromGpu(gmx::ArrayRef<gmx::RVec> h_x, AtomLocality atomLocality);
 216
 217     /*! \brief Wait until coordinates are available on the host.
 218      *
 219      *  \param[in] atomLocality  Locality of the particles to wait for.
 220      */
 221     void waitCoordinatesReadyOnHost(AtomLocality atomLocality);
 222
 223
 224     /*! \brief Get the velocities buffer on the GPU.
 225      *
 226      *  \returns GPU velocities buffer.
 227      */
 228     DeviceBuffer<RVec> getVelocities();
 229
 230     /*! \brief Copy velocities to the GPU memory.
 231      *
 232      *  \param[in] h_v           Velocities in the host memory.
 233      *  \param[in] atomLocality  Locality of the particles to copy.
 234      */
 235     void copyVelocitiesToGpu(gmx::ArrayRef<const gmx::RVec> h_v, AtomLocality atomLocality);
 236
 237     /*! \brief Get the event synchronizer for the H2D velocities copy.
 238      *
 239      *  \param[in] atomLocality  Locality of the particles to wait for.
 240      *
 241      *  \returns  The event to synchronize the stream that consumes velocities on device.
 242      */
 243     GpuEventSynchronizer* getVelocitiesReadyOnDeviceEvent(AtomLocality atomLocality);
 244
 245     /*! \brief Copy velocities from the GPU memory.
 246      *
 247      *  \param[in] h_v           Velocities buffer in the host memory.
 248      *  \param[in] atomLocality  Locality of the particles to copy.
 249      */
 250     void copyVelocitiesFromGpu(gmx::ArrayRef<gmx::RVec> h_v, AtomLocality atomLocality);
 251
 252     /*! \brief Wait until velocities are available on the host.
 253      *
 254      *  \param[in] atomLocality  Locality of the particles to wait for.
 255      */
 256     void waitVelocitiesReadyOnHost(AtomLocality atomLocality);
 257
 258
 259     /*! \brief Get the force buffer on the GPU.
 260      *
 261      *  \returns GPU force buffer.
 262      */
 263     DeviceBuffer<RVec> getForces();
 264
 265     /*! \brief Copy forces to the GPU memory.
 266      *
 267      *  \param[in] h_f           Forces in the host memory.
 268      *  \param[in] atomLocality  Locality of the particles to copy.
 269      */
 270     void copyForcesToGpu(gmx::ArrayRef<const gmx::RVec> h_f, AtomLocality atomLocality);
 271
 272     /*! \brief Get the event synchronizer for the forces ready on device.
 273      *
 274      *  Returns either of the event synchronizers, depending on the offload scenario
 275      *  for the current simulation timestep:
 276      *  1. The forces are copied to the device (when GPU buffer ops are off)
 277      *  2. The forces are reduced on the device (GPU buffer ops are on)
 278      *
 279      *  \todo Pass step workload instead of the useGpuFBufferOps boolean.
 280      *
 281      *  \param[in] atomLocality      Locality of the particles to wait for.
 282      *  \param[in] useGpuFBufferOps  If the force buffer ops are offloaded to the GPU.
 283      *
 284      *  \returns  The event to synchronize the stream that consumes forces on device.
 285      */
 286     GpuEventSynchronizer* getForcesReadyOnDeviceEvent(AtomLocality atomLocality, bool useGpuFBufferOps);
 287
 288     /*! \brief Getter for the event synchronizer for the forces are reduced on the GPU.
 289      *
 290      *  \returns  The event to mark when forces are reduced on the GPU.
 291      */
 292     GpuEventSynchronizer* fReducedOnDevice();
 293
 294     /*! \brief Copy forces from the GPU memory.
 295      *
 296      *  \param[in] h_f           Forces buffer in the host memory.
 297      *  \param[in] atomLocality  Locality of the particles to copy.
 298      */
 299     void copyForcesFromGpu(gmx::ArrayRef<gmx::RVec> h_f, AtomLocality atomLocality);
 300
 301     /*! \brief Wait until forces are available on the host.
 302      *
 303      *  \param[in] atomLocality  Locality of the particles to wait for.
 304      */
 305     void waitForcesReadyOnHost(AtomLocality atomLocality);
 306
 307     /*! \brief Getter for the update stream.
 308      *
 309      *  \todo This is temporary here, until the management of this stream is taken over.
 310      *
 311      *  \returns The device command stream to use in update-constraints.
 312      */
 313     const DeviceStream* getUpdateStream();
 314
 315     /*! \brief Getter for the number of local atoms.
 316      *
 317      *  \returns The number of local atoms.
 318      */
 319     int numAtomsLocal();
 320
 321     /*! \brief Getter for the total number of atoms.
 322      *
 323      *  \returns The total number of atoms.
 324      */
 325     int numAtomsAll();
 326
 327 private:
 328     class Impl;
 329     gmx::PrivateImplPointer<Impl> impl_;
 330     GMX_DISALLOW_COPY_AND_ASSIGN(StatePropagatorDataGpu);
 331 };
 332
 333 } // namespace gmx
 334
 335 #endif // GMX_MDTYPES_STATE_PROPAGATOR_DATA_GPU_H