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