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