src/gromacs/mdtypes/state_propagator_data_gpu_impl.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 low-level functions and fields of GPU state propagator object.
  38  *
  39  * \author Artem Zhmurov <zhmurov@gmail.com>
  40  *
  41  * \ingroup module_mdtypes
  42  */
  43 #ifndef GMX_MDTYPES_STATE_PROPAGATOR_DATA_GPU_IMPL_H
  44 #define GMX_MDTYPES_STATE_PROPAGATOR_DATA_GPU_IMPL_H
  45
  46 #include "gmxpre.h"
  47
  48 #include "config.h"
  49
  50 #include "gromacs/gpu_utils/devicebuffer.h"
  51 #if GMX_GPU == GMX_GPU_CUDA
  52 #    include "gromacs/gpu_utils/gpueventsynchronizer.cuh"
  53 #elif GMX_GPU == GMX_GPU_OPENCL
  54 #    include "gromacs/gpu_utils/gpueventsynchronizer_ocl.h"
  55 #endif
  56 #include "gromacs/math/vectypes.h"
  57 #include "gromacs/mdtypes/state_propagator_data_gpu.h"
  58 #include "gromacs/utility/classhelpers.h"
  59 #include "gromacs/utility/enumerationhelpers.h"
  60
  61 struct gmx_wallcycle;
  62
  63 namespace gmx
  64 {
  65
  66 class StatePropagatorDataGpu::Impl
  67 {
  68 public:
  69     Impl();
  70
  71
  72     /*! \brief Constructor
  73      *
  74      * The buffers are reallocated only at the reinit call, the padding is
  75      * used there for the coordinates buffer. It is needed for PME and added at
  76      * the end of the buffer. It is assumed that if the rank has PME duties on the
  77      * GPU, all coordinates are copied to the GPU and hence, for this rank, the
  78      * coordinates buffer is not split into local and non-local ranges. For other
  79      * ranks, the padding size is zero. This works because only one rank ever does
  80      * PME work on the GPU, and if that rank also does PP work that is the only
  81      * rank. So all coordinates are always transferred.
  82      *
  83      * In OpenCL, only pmeStream is used since it is the only stream created in
  84      * PME context. The local and non-local streams are only needed when buffer
  85      * ops are offloaded. This feature is currently not available in OpenCL and
  86      * hence these streams are not set in these builds.
  87      *
  88      * \note In CUDA, the update stream is created in the constructor as a temporary
  89      *       solution, in place until the stream manager is introduced.
  90      *       Note that this makes it impossible to construct this object in CUDA
  91      *       builds executing on a host without any CUDA-capable device available.
  92      *
  93      * \note In CUDA, \p deviceContext is unused, hence always nullptr;
  94      *       all stream arguments can also be nullptr in runs where the
  95      *       respective streams are not required.
  96      *       In OpenCL, \p deviceContext needs to be a valid device context.
  97      *       In OpenCL runs StatePropagatorDataGpu is currently only used
  98      *       with PME offload, and only on ranks with PME duty. Hence, the
  99      *       \p pmeStream argument needs to be a valid OpenCL queue object
 100      *       which must have been created in \p deviceContext.
 101      *
 102      * \todo Make a \p CommandStream visible in the CPU parts of the code so we
 103      *       will not have to pass a void*.
 104      *
 105      *  \param[in] pmeStream       Device PME stream, nullptr allowed.
 106      *  \param[in] localStream     Device NBNXM local stream, nullptr allowed.
 107      *  \param[in] nonLocalStream  Device NBNXM non-local stream, nullptr allowed.
 108      *  \param[in] deviceContext   Device context, nullptr allowed.
 109      *  \param[in] transferKind    H2D/D2H transfer call behavior (synchronous or not).
 110      *  \param[in] paddingSize     Padding size for coordinates buffer.
 111      *  \param[in] wcycle          Wall cycle counter data.
 112      */
 113     Impl(const void*          pmeStream,
 114          const void*          localStream,
 115          const void*          nonLocalStream,
 116          const DeviceContext& deviceContext,
 117          GpuApiCallBehavior   transferKind,
 118          int                  paddingSize,
 119          gmx_wallcycle*       wcycle);
 120
 121     /*! \brief Constructor to use in PME-only rank and in tests.
 122      *
 123      *  This constructor should be used if only a coordinate device buffer should be managed
 124      *  using a single stream. Any operation on force or velocity buffer as well as copy of
 125      *  non-local coordinates will exit with assertion failure. Note, that the pmeStream can
 126      *  not be a nullptr and the constructor will exit with an assertion failure.
 127      *
 128      *  \todo Currently, unsupported copy operations are blocked by assertion that the stream
 129      *        not nullptr. This should be improved.
 130      *
 131      *  \param[in] pmeStream       Device PME stream, nullptr is not allowed.
 132      *  \param[in] deviceContext   Device context, nullptr allowed for non-OpenCL builds.
 133      *  \param[in] transferKind    H2D/D2H transfer call behavior (synchronous or not).
 134      *  \param[in] paddingSize     Padding size for coordinates buffer.
 135      *  \param[in] wcycle          Wall cycle counter data.
 136      */
 137     Impl(const void*          pmeStream,
 138          const DeviceContext& deviceContext,
 139          GpuApiCallBehavior   transferKind,
 140          int                  paddingSize,
 141          gmx_wallcycle*       wcycle);
 142
 143     ~Impl();
 144
 145
 146     /*! \brief Set the ranges for local and non-local atoms and reallocates buffers.
 147      *
 148      * Reallocates coordinate, velocities and force buffers on the device.
 149      *
 150      * \note
 151      * The coordinates buffer is (re)allocated, when required by PME, with a padding,
 152      * the size of which is set by the constructor. The padding region clearing kernel
 153      * is scheduled in the \p pmeStream_ (unlike the coordinates H2D) as only the PME
 154      * task uses this padding area.
 155      *
 156      * \note
 157      * The force buffer is cleared if its size increases, so that previously unused
 158      * memory is cleared before forces are accumulated.
 159      *
 160      *  \param[in] numAtomsLocal  Number of atoms in local domain.
 161      *  \param[in] numAtomsAll    Total number of atoms to handle.
 162      */
 163     void reinit(int numAtomsLocal, int numAtomsAll);
 164
 165     /*! \brief Returns the range of atoms to be copied based on the copy type (all, local or non-local).
 166      *
 167      * \todo There are at least three versions of the function with this functionality in the code:
 168      *       this one and two more in NBNXM. These should be unified in a shape of a general function
 169      *       in DD.
 170      *
 171      * \param[in]  atomLocality    If all, local or non-local ranges are needed.
 172      *
 173      * \returns Tuple, containing the index of the first atom in the range and the total number of atoms in the range.
 174      */
 175     std::tuple<int, int> getAtomRangesFromAtomLocality(AtomLocality atomLocality);
 176
 177
 178     /*! \brief Get the positions buffer on the GPU.
 179      *
 180      *  \returns GPU positions buffer.
 181      */
 182     DeviceBuffer<RVec> getCoordinates();
 183
 184     /*! \brief Copy positions to the GPU memory.
 185      *
 186      *  \param[in] h_x           Positions in the host memory.
 187      *  \param[in] atomLocality  Locality of the particles to copy.
 188      */
 189     void copyCoordinatesToGpu(gmx::ArrayRef<const gmx::RVec> h_x, AtomLocality atomLocality);
 190
 191     /*! \brief Get the event synchronizer of the coordinates ready for the consumption on the device.
 192      *
 193      * Returns the event synchronizer which indicates that the coordinates are ready for the
 194      * consumption on the device. Takes into account that the producer may be different.
 195      *
 196      * If the update is offloaded, and the current step is not a DD/search step, the returned
 197      * synchronizer indicates the completion of GPU update-constraint kernels. Otherwise, on search
 198      * steps and if update is not offloaded, the coordinates are provided by the H2D copy and the
 199      * returned synchronizer indicates that the copy is complete.
 200      *
 201      *  \param[in] atomLocality    Locality of the particles to wait for.
 202      *  \param[in] simulationWork  The simulation lifetime flags.
 203      *  \param[in] stepWork        The step lifetime flags.
 204      *
 205      *  \returns  The event to synchronize the stream that consumes coordinates on device.
 206      */
 207     GpuEventSynchronizer* getCoordinatesReadyOnDeviceEvent(AtomLocality              atomLocality,
 208                                                            const SimulationWorkload& simulationWork,
 209                                                            const StepWorkload&       stepWork);
 210
 211     /*! \brief Blocking wait until coordinates are copied to the device.
 212      *
 213      * Synchronizes the stream in which the copy was executed.
 214      *
 215      *  \param[in] atomLocality  Locality of the particles to wait for.
 216      */
 217     void waitCoordinatesCopiedToDevice(AtomLocality atomLocality);
 218
 219     /*! \brief Getter for the event synchronizer for the update is done on th GPU
 220      *
 221      *  \returns  The event to synchronize the stream coordinates wre updated on device.
 222      */
 223     GpuEventSynchronizer* xUpdatedOnDevice();
 224
 225     /*! \brief Copy positions from the GPU memory.
 226      *
 227      *  \param[in] h_x           Positions buffer in the host memory.
 228      *  \param[in] atomLocality  Locality of the particles to copy.
 229      */
 230     void copyCoordinatesFromGpu(gmx::ArrayRef<gmx::RVec> h_x, AtomLocality atomLocality);
 231
 232     /*! \brief Wait until coordinates are available on the host.
 233      *
 234      *  \param[in] atomLocality  Locality of the particles to wait for.
 235      */
 236     void waitCoordinatesReadyOnHost(AtomLocality atomLocality);
 237
 238
 239     /*! \brief Get the velocities buffer on the GPU.
 240      *
 241      *  \returns GPU velocities buffer.
 242      */
 243     DeviceBuffer<RVec> getVelocities();
 244
 245     /*! \brief Copy velocities to the GPU memory.
 246      *
 247      *  \param[in] h_v           Velocities in the host memory.
 248      *  \param[in] atomLocality  Locality of the particles to copy.
 249      */
 250     void copyVelocitiesToGpu(gmx::ArrayRef<const gmx::RVec> h_v, AtomLocality atomLocality);
 251
 252     /*! \brief Get the event synchronizer on the H2D velocities copy.
 253      *
 254      *  \param[in] atomLocality  Locality of the particles to wait for.
 255      *
 256      *  \returns  The event to synchronize the stream that consumes velocities on device.
 257      */
 258     GpuEventSynchronizer* getVelocitiesReadyOnDeviceEvent(AtomLocality atomLocality);
 259
 260     /*! \brief Copy velocities from the GPU memory.
 261      *
 262      *  \param[in] h_v           Velocities buffer in the host memory.
 263      *  \param[in] atomLocality  Locality of the particles to copy.
 264      */
 265     void copyVelocitiesFromGpu(gmx::ArrayRef<gmx::RVec> h_v, AtomLocality atomLocality);
 266
 267     /*! \brief Wait until velocities are available on the host.
 268      *
 269      *  \param[in] atomLocality  Locality of the particles to wait for.
 270      */
 271     void waitVelocitiesReadyOnHost(AtomLocality atomLocality);
 272
 273
 274     /*! \brief Get the force buffer on the GPU.
 275      *
 276      *  \returns GPU force buffer.
 277      */
 278     DeviceBuffer<RVec> getForces();
 279
 280     /*! \brief Copy forces to the GPU memory.
 281      *
 282      *  \param[in] h_f           Forces in the host memory.
 283      *  \param[in] atomLocality  Locality of the particles to copy.
 284      */
 285     void copyForcesToGpu(gmx::ArrayRef<const gmx::RVec> h_f, AtomLocality atomLocality);
 286
 287     /*! \brief Get the event synchronizer for the forces ready on device.
 288      *
 289      *  Returns either of the event synchronizers, depending on the offload scenario
 290      *  for the current simulation timestep:
 291      *  1. The forces are copied to the device (when GPU buffer ops are off)
 292      *  2. The forces are reduced on the device (GPU buffer ops are on)
 293      *
 294      *  \todo Pass step workload instead of the useGpuFBufferOps boolean.
 295      *
 296      *  \param[in] atomLocality      Locality of the particles to wait for.
 297      *  \param[in] useGpuFBufferOps  If the force buffer ops are offloaded to the GPU.
 298      *
 299      *  \returns  The event to synchronize the stream that consumes forces on device.
 300      */
 301     GpuEventSynchronizer* getForcesReadyOnDeviceEvent(AtomLocality atomLocality, bool useGpuFBufferOps);
 302
 303     /*! \brief Getter for the event synchronizer for the forces are reduced on the GPU.
 304      *
 305      *  \returns  The event to mark when forces are reduced on the GPU.
 306      */
 307     GpuEventSynchronizer* fReducedOnDevice();
 308
 309     /*! \brief Copy forces from the GPU memory.
 310      *
 311      *  \param[in] h_f           Forces buffer in the host memory.
 312      *  \param[in] atomLocality  Locality of the particles to copy.
 313      */
 314     void copyForcesFromGpu(gmx::ArrayRef<gmx::RVec> h_f, AtomLocality atomLocality);
 315
 316     /*! \brief Wait until forces are available on the host.
 317      *
 318      *  \param[in] atomLocality  Locality of the particles to wait for.
 319      */
 320     void waitForcesReadyOnHost(AtomLocality atomLocality);
 321
 322     /*! \brief Getter for the update stream.
 323      *
 324      *  \todo This is temporary here, until the management of this stream is taken over.
 325      *
 326      *  \returns The device command stream to use in update-constraints.
 327      */
 328     void* getUpdateStream();
 329
 330     /*! \brief Getter for the number of local atoms.
 331      *
 332      *  \returns The number of local atoms.
 333      */
 334     int numAtomsLocal();
 335
 336     /*! \brief Getter for the total number of atoms.
 337      *
 338      *  \returns The total number of atoms.
 339      */
 340     int numAtomsAll();
 341
 342 private:
 343     //! GPU PME stream.
 344     CommandStream pmeStream_ = nullptr;
 345     //! GPU NBNXM local stream.
 346     CommandStream localStream_ = nullptr;
 347     //! GPU NBNXM non-local stream
 348     CommandStream nonLocalStream_ = nullptr;
 349     //! GPU Update-constreaints stream.
 350     CommandStream updateStream_ = nullptr;
 351
 352     // Streams to use for coordinates H2D and D2H copies (one event for each atom locality)
 353     EnumerationArray<AtomLocality, CommandStream> xCopyStreams_ = { { nullptr } };
 354     // Streams to use for velocities H2D and D2H copies (one event for each atom locality)
 355     EnumerationArray<AtomLocality, CommandStream> vCopyStreams_ = { { nullptr } };
 356     // Streams to use for forces H2D and D2H copies (one event for each atom locality)
 357     EnumerationArray<AtomLocality, CommandStream> fCopyStreams_ = { { nullptr } };
 358
 359     /*! \brief An array of events that indicate H2D copy is complete (one event for each atom locality)
 360      *
 361      * \todo Reconsider naming. It should be xCopiedToDevice or xH2DCopyComplete, etc.
 362      */
 363     EnumerationArray<AtomLocality, GpuEventSynchronizer> xReadyOnDevice_;
 364     //! An event that the coordinates are ready after update-constraints execution
 365     GpuEventSynchronizer xUpdatedOnDevice_;
 366     //! An array of events that indicate D2H copy of coordinates is complete (one event for each atom locality)
 367     EnumerationArray<AtomLocality, GpuEventSynchronizer> xReadyOnHost_;
 368
 369     //! An array of events that indicate H2D copy of velocities is complete (one event for each atom locality)
 370     EnumerationArray<AtomLocality, GpuEventSynchronizer> vReadyOnDevice_;
 371     //! An array of events that indicate D2H copy of velocities is complete (one event for each atom locality)
 372     EnumerationArray<AtomLocality, GpuEventSynchronizer> vReadyOnHost_;
 373
 374     //! An array of events that indicate H2D copy of forces is complete (one event for each atom locality)
 375     EnumerationArray<AtomLocality, GpuEventSynchronizer> fReadyOnDevice_;
 376     //! An event that the forces were reduced on the GPU
 377     GpuEventSynchronizer fReducedOnDevice_;
 378     //! An array of events that indicate D2H copy of forces is complete (one event for each atom locality)
 379     EnumerationArray<AtomLocality, GpuEventSynchronizer> fReadyOnHost_;
 380
 381     //! GPU context (for OpenCL builds)
 382     const DeviceContext& deviceContext_;
 383     //! Default GPU calls behavior
 384     GpuApiCallBehavior transferKind_ = GpuApiCallBehavior::Async;
 385     //! Padding size for the coordinates buffer
 386     int paddingSize_ = 0;
 387
 388     //! Number of local atoms
 389     int numAtomsLocal_ = -1;
 390     //! Total number of atoms
 391     int numAtomsAll_ = -1;
 392
 393     //! Device positions buffer
 394     DeviceBuffer<RVec> d_x_;
 395     //! Number of particles saved in the positions buffer
 396     int d_xSize_ = -1;
 397     //! Allocation size for the positions buffer
 398     int d_xCapacity_ = -1;
 399
 400     //! Device velocities buffer
 401     DeviceBuffer<RVec> d_v_;
 402     //! Number of particles saved in the velocities buffer
 403     int d_vSize_ = -1;
 404     //! Allocation size for the velocities buffer
 405     int d_vCapacity_ = -1;
 406
 407     //! Device force buffer
 408     DeviceBuffer<RVec> d_f_;
 409     //! Number of particles saved in the force buffer
 410     int d_fSize_ = -1;
 411     //! Allocation size for the force buffer
 412     int d_fCapacity_ = -1;
 413
 414     //! \brief Pointer to wallcycle structure.
 415     gmx_wallcycle* wcycle_;
 416
 417     /*! \brief Performs the copy of data from host to device buffer.
 418      *
 419      * \todo Template on locality.
 420      *
 421      *  \param[out] d_data         Device-side buffer.
 422      *  \param[in]  h_data         Host-side buffer.
 423      *  \param[in]  dataSize       Device-side data allocation size.
 424      *  \param[in]  atomLocality   If all, local or non-local ranges should be copied.
 425      *  \param[in]  commandStream  GPU stream to execute copy in.
 426      */
 427     void copyToDevice(DeviceBuffer<RVec>             d_data,
 428                       gmx::ArrayRef<const gmx::RVec> h_data,
 429                       int                            dataSize,
 430                       AtomLocality                   atomLocality,
 431                       CommandStream                  commandStream);
 432
 433     /*! \brief Performs the copy of data from device to host buffer.
 434      *
 435      *  \param[out] h_data         Host-side buffer.
 436      *  \param[in]  d_data         Device-side buffer.
 437      *  \param[in]  dataSize       Device-side data allocation size.
 438      *  \param[in]  atomLocality   If all, local or non-local ranges should be copied.
 439      *  \param[in]  commandStream  GPU stream to execute copy in.
 440      */
 441     void copyFromDevice(gmx::ArrayRef<gmx::RVec> h_data,
 442                         DeviceBuffer<RVec>       d_data,
 443                         int                      dataSize,
 444                         AtomLocality             atomLocality,
 445                         CommandStream            commandStream);
 446 };
 447
 448 } // namespace gmx
 449
 450 #endif // GMX_MDTYPES_STATE_PROPAGATOR_DATA_GPU_IMPL_H