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