src/gromacs/gpu_utils/gpueventsynchronizer.cuh

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019,2020,2021, 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 /*! \libinternal \file
  36  *  \brief Implements a GpuEventSynchronizer class for CUDA.
  37  *
  38  *  \author Aleksei Iupinov <a.yupinov@gmail.com>
  39  *  \inlibraryapi
  40  */
  41 #ifndef GMX_GPU_UTILS_GPUEVENTSYNCHRONIZER_CUH
  42 #define GMX_GPU_UTILS_GPUEVENTSYNCHRONIZER_CUH
  43
  44 #include "gromacs/gpu_utils/cudautils.cuh"
  45 #include "gromacs/gpu_utils/device_stream.h"
  46 #include "gromacs/gpu_utils/gputraits.cuh"
  47 #include "gromacs/utility/gmxassert.h"
  48
  49 #ifndef DOXYGEN
  50
  51 /*! \libinternal \brief
  52  * A class which allows for CPU thread to mark and wait for certain GPU stream execution point.
  53  * The event can be put into the stream with markEvent() and then later waited on with waitForEvent().
  54  * This can be repeated as necessary, but the current implementation does not allow waiting on
  55  * completed event more than once, expecting only exact pairs of markEvent(stream); waitForEvent().
  56  * The class generally attempts to track the correctness of its state transitions, but
  57  * please note that calling waitForEvent() right after the construction will succeed with CUDA but fail with OpenCL.
  58  *
  59  * Another possible mode of operation can be implemented if needed:
  60  * multiple calls to waitForEvent() after a single markEvent().
  61  * For this, only some small alterations to gpueventsynchronizer_ocl.h need to be made.
  62  * This was tested to work both with CUDA and NVidia OpenCL, but not with AMD/Intel OpenCL.
  63  */
  64 class GpuEventSynchronizer
  65 {
  66 public:
  67     GpuEventSynchronizer()
  68     {
  69         cudaError_t gmx_used_in_debug stat = cudaEventCreateWithFlags(&event_, cudaEventDisableTiming);
  70         GMX_RELEASE_ASSERT(stat == cudaSuccess,
  71                            ("cudaEventCreate failed. " + gmx::getDeviceErrorString(stat)).c_str());
  72     }
  73     ~GpuEventSynchronizer()
  74     {
  75         cudaError_t gmx_used_in_debug stat = cudaEventDestroy(event_);
  76         GMX_RELEASE_ASSERT(stat == cudaSuccess,
  77                            ("cudaEventDestroy failed. " + gmx::getDeviceErrorString(stat)).c_str());
  78     }
  79     //! No copying
  80     GpuEventSynchronizer(const GpuEventSynchronizer&) = delete;
  81     //! No assignment
  82     GpuEventSynchronizer& operator=(GpuEventSynchronizer&&) = delete;
  83     //! Moving is disabled but can be considered in the future if needed
  84     GpuEventSynchronizer(GpuEventSynchronizer&&) = delete;
  85
  86     /*! \brief Marks the synchronization point in the \p stream.
  87      * Should be followed by waitForEvent().
  88      */
  89     inline void markEvent(const DeviceStream& deviceStream)
  90     {
  91         cudaError_t gmx_used_in_debug stat = cudaEventRecord(event_, deviceStream.stream());
  92         GMX_ASSERT(stat == cudaSuccess,
  93                    ("cudaEventRecord failed. " + gmx::getDeviceErrorString(stat)).c_str());
  94     }
  95     /*! \brief Synchronizes the host thread on the marked event. */
  96     inline void waitForEvent()
  97     {
  98         cudaError_t gmx_used_in_debug stat = cudaEventSynchronize(event_);
  99         GMX_ASSERT(stat == cudaSuccess,
 100                    ("cudaEventSynchronize failed. " + gmx::getDeviceErrorString(stat)).c_str());
 101     }
 102     /*! \brief Checks the completion of the underlying event and resets the object if it was. */
 103     inline bool isReady()
 104     {
 105         cudaError_t gmx_used_in_debug stat = cudaEventQuery(event_);
 106         GMX_ASSERT((stat == cudaSuccess) || (stat == cudaErrorNotReady),
 107                    ("cudaEventQuery failed. " + gmx::getDeviceErrorString(stat)).c_str());
 108         return (stat == cudaSuccess);
 109     }
 110     /*! \brief Enqueues a wait for the recorded event in stream \p stream */
 111     inline void enqueueWaitEvent(const DeviceStream& deviceStream)
 112     {
 113         cudaError_t gmx_used_in_debug stat = cudaStreamWaitEvent(deviceStream.stream(), event_, 0);
 114         GMX_ASSERT(stat == cudaSuccess,
 115                    ("cudaStreamWaitEvent failed. " + gmx::getDeviceErrorString(stat)).c_str());
 116     }
 117
 118 private:
 119     cudaEvent_t event_;
 120 };
 121
 122 #endif
 123
 124 #endif