src/gromacs/gpu_utils/gpueventsynchronizer.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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.
  37  *
  38  *  \author Andrey Alekseenko <al42and@gmail.com>
  39  *  \author Artem Zhmurov <zhmurov@gmail.com>
  40  *  \author Aleksei Iupinov <a.yupinov@gmail.com>
  41  * \inlibraryapi
  42  */
  43 #ifndef GMX_GPU_UTILS_GPUEVENTSYNCHRONIZER_H
  44 #define GMX_GPU_UTILS_GPUEVENTSYNCHRONIZER_H
  45
  46 #include "config.h"
  47
  48 #include "gromacs/utility/classhelpers.h"
  49 #include "gromacs/utility/exceptions.h"
  50 #include "gromacs/utility/gmxassert.h"
  51
  52 #include "device_event.h"
  53
  54 /*! \libinternal \brief
  55  * A class which allows for CPU thread to mark and wait for certain GPU stream execution point.
  56  * The event can be put into the stream with \ref markEvent() and then later waited on with \ref waitForEvent().
  57  * This can be repeated as necessary, but the current implementation does not allow waiting on
  58  * completed event more than once, expecting only exact pairs of markEvent(stream); waitForEvent().
  59  * The class generally attempts to track the correctness of its state transitions, but
  60  * please note that calling waitForEvent() right after the construction will fail with OpenCL but succeed with CUDA.
  61  */
  62 class GpuEventSynchronizer
  63 {
  64 public:
  65     //! A constructor
  66     GpuEventSynchronizer() = default;
  67     //! A destructor
  68     ~GpuEventSynchronizer() = default;
  69     //! Remove copy assignment, because we can not copy the underlying event object.
  70     GpuEventSynchronizer& operator=(const GpuEventSynchronizer&) = delete;
  71     //! Remove copy constructor, because we can not copy the underlying event object.
  72     GpuEventSynchronizer(const GpuEventSynchronizer&) = delete;
  73     //! Remove move assignment, because we don't allow moving the underlying event object.
  74     GpuEventSynchronizer& operator=(GpuEventSynchronizer&&) = delete;
  75     //! Remove move constructor, because we don't allow moving the underlying event object.
  76     GpuEventSynchronizer(GpuEventSynchronizer&&) = delete;
  77
  78     /*! \brief Marks the synchronization point in the \p stream.
  79      * Should be called first and then followed by \ref waitForEvent().
  80      */
  81     inline void markEvent(const DeviceStream& deviceStream)
  82     {
  83 #if !GMX_GPU_CUDA // For now, we have relaxed conditions for CUDA
  84         if (event_.isMarked())
  85         {
  86             GMX_THROW(gmx::InternalError("Trying to mark event before first consuming it"));
  87         }
  88 #endif
  89         event_.mark(deviceStream);
  90     }
  91     /*! \brief Synchronizes the host thread on the marked event. */
  92     inline void waitForEvent()
  93     {
  94 #if !GMX_GPU_CUDA // For now, we have relaxed conditions for CUDA
  95         if (!event_.isMarked())
  96         {
  97             GMX_THROW(gmx::InternalError(
  98                     "Trying to wait for event before marking it or after fully consuming it"));
  99         }
 100 #endif
 101         event_.wait();
 102         reset();
 103     }
 104     /*! \brief Checks the completion of the underlying event and resets the object if it was. */
 105     inline bool isReady()
 106     {
 107 #if !GMX_GPU_CUDA // For now, we have relaxed conditions for CUDA
 108         if (!event_.isMarked())
 109         {
 110             GMX_THROW(gmx::InternalError("Trying to check the status of event before marking it"));
 111         }
 112 #endif
 113         bool isReady = event_.isReady();
 114         if (isReady)
 115         {
 116             reset();
 117         }
 118         return isReady;
 119     }
 120     /*! \brief Enqueues a wait for the recorded event in stream \p stream
 121      *
 122      *  After enqueue, the associated event is released, so this method should
 123      *  be only called once per \ref markEvent() call (not enforced in CUDA yet).
 124      */
 125     inline void enqueueWaitEvent(const DeviceStream& deviceStream)
 126     {
 127 #if !GMX_GPU_CUDA // For now, we have relaxed conditions for CUDA
 128         if (!event_.isMarked())
 129         {
 130             GMX_THROW(
 131                     gmx::InternalError("Trying to enqueue wait for event before marking it or "
 132                                        "after fully consuming it"));
 133         }
 134 #endif
 135         event_.enqueueWait(deviceStream);
 136         reset();
 137     }
 138
 139     //! Resets the event to unmarked state, releasing the underlying event object if needed.
 140     inline void reset() { event_.reset(); }
 141
 142 private:
 143     DeviceEvent event_;
 144 };
 145
 146 #endif