src/gromacs/gpu_utils/gpueventsynchronizer_sycl.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 SYCL.
  37  *
  38  *  This implementation relies on SYCL_INTEL_enqueue_barrier proposal,
  39  *  https://github.com/intel/llvm/blob/sycl/sycl/doc/extensions/EnqueueBarrier/enqueue_barrier.asciidoc
  40  *
  41  *  Using event-based synchronization is not recommended for SYCL.
  42  *  SYCL queues are out-of-order and rely on data dependencies, allowing only to wait
  43  *  for a specific kernel (by capturing the \c event returned from \c queue.submit) or for all
  44  *  the tasks in the queue (\c queue.wait).
  45  *
  46  *  \author Erik Lindahl <erik.lindahl@gmail.com>
  47  *  \author Andrey Alekseenko <al42and@gmail.com>
  48  * \inlibraryapi
  49  */
  50 #ifndef GMX_GPU_UTILS_GPUEVENTSYNCHRONIZER_SYCL_H
  51 #define GMX_GPU_UTILS_GPUEVENTSYNCHRONIZER_SYCL_H
  52
  53 #include <optional>
  54
  55 #include "gromacs/gpu_utils/device_stream.h"
  56 #include "gromacs/gpu_utils/gmxsycl.h"
  57 #include "gromacs/utility/exceptions.h"
  58 #include "gromacs/utility/gmxassert.h"
  59
  60 #ifndef DOXYGEN
  61 /*! \libinternal \brief
  62  * A class which allows for CPU thread to mark and wait for certain GPU stream execution point.
  63  * The event can be put into the stream with markEvent() and then later waited on with waitForEvent().
  64  * This can be repeated as necessary, but the current implementation does not allow waiting on
  65  * completed event more than once, expecting only exact pairs of markEvent(stream); waitForEvent().
  66  * The class generally attempts to track the correctness of its state transitions, but
  67  * please note that calling waitForEvent() right after the construction will fail with OpenCL
  68  * and SYCL but succeed with CUDA.
  69  *
  70  * Another possible mode of operation can be implemented if needed:
  71  * multiple calls to waitForEvent() after a single markEvent(). For this, event.reset() call
  72  * from waitForEvent() should instead happen conditionally at the beginning of markEvent(), replacing
  73  * the GMX_ASSERT(). This was tested to work both with CUDA, NVidia OpenCL, and Intel SYCL,
  74  * but not with AMD/Intel OpenCl.
  75  *
  76  *  \warning This class is offered for uniformity with other GPU implementations, but expect it to
  77  *  be deprecated in the future.
  78  *
  79  */
  80 class GpuEventSynchronizer
  81 {
  82 public:
  83     //! A constructor.
  84     GpuEventSynchronizer()
  85     {
  86         doNotSynchronizeBetweenStreams_ = (std::getenv("GMX_GPU_SYCL_NO_SYNCHRONIZE") != nullptr);
  87     }
  88     //! A constructor from an existing event.
  89     GpuEventSynchronizer(const cl::sycl::event& event) : event_(event) {}
  90     //! A destructor.
  91     ~GpuEventSynchronizer() = default;
  92     //! No copying
  93     GpuEventSynchronizer(const GpuEventSynchronizer&) = delete;
  94     //! No assignment
  95     GpuEventSynchronizer& operator=(GpuEventSynchronizer&&) = delete;
  96     //! Moving is disabled but can be considered in the future if needed
  97     GpuEventSynchronizer(GpuEventSynchronizer&&) = delete;
  98
  99     /*! \brief Marks the synchronization point in the \p deviceStream.
 100      * Should be called first and then followed by waitForEvent() or enqueueWaitEvent().
 101      */
 102     inline void markEvent(const DeviceStream& deviceStream)
 103     {
 104 #    if GMX_SYCL_HIPSYCL
 105         deviceStream.stream().wait_and_throw(); // SYCL-TODO: Use CUDA/HIP-specific solutions
 106 #    else
 107         GMX_ASSERT(!event_.has_value(), "Do not call markEvent more than once!");
 108         // Relies on SYCL_INTEL_enqueue_barrier
 109         event_ = deviceStream.stream().submit_barrier();
 110 #    endif
 111     }
 112     /*! \brief Synchronizes the host thread on the marked event.
 113      * As in the OpenCL implementation, the event is released.
 114      */
 115     inline void waitForEvent()
 116     {
 117 #    if (!GMX_SYCL_HIPSYCL)
 118         event_->wait_and_throw();
 119 #    endif
 120         event_.reset();
 121     }
 122     /*! \brief Checks the completion of the underlying event and resets the object if it was. */
 123     inline bool isReady()
 124     {
 125         auto info         = event_->get_info<cl::sycl::info::event::command_execution_status>();
 126         bool hasTriggered = (info == cl::sycl::info::event_command_status::complete);
 127         if (hasTriggered)
 128         {
 129             event_.reset();
 130         }
 131         return hasTriggered;
 132     }
 133     /*! \brief Enqueues a wait for the recorded event in stream \p deviceStream.
 134      * As in the OpenCL implementation, the event is released.
 135      */
 136     inline void enqueueWaitEvent(const DeviceStream& deviceStream)
 137     {
 138         if (doNotSynchronizeBetweenStreams_)
 139         {
 140             event_.reset();
 141             return;
 142         }
 143 #    if GMX_SYCL_HIPSYCL
 144         deviceStream.stream().wait_and_throw(); // SYCL-TODO: Use CUDA/HIP-specific solutions
 145 #    else
 146         // Relies on SYCL_INTEL_enqueue_barrier
 147         const std::vector<cl::sycl::event> waitlist{ event_.value() };
 148         deviceStream.stream().submit_barrier(waitlist);
 149         event_.reset();
 150 #    endif
 151     }
 152     //! Reset the event to unmarked state.
 153     inline void reset() { event_.reset(); }
 154     //! Check if the event is marked. Needed for some workarounds for #3988
 155     inline bool isMarked() const { return event_.has_value(); }
 156
 157 private:
 158     std::optional<cl::sycl::event> event_ = std::nullopt;
 159     /*! \brief Dev. setting to no-op enqueueWaitEvent
 160      *
 161      * In SYCL, dependencies between the GPU tasks are managed by the runtime, so manual
 162      * synchronization between GPU streams should be redundant, but we keep it on by default.
 163      *
 164      * Setting this to \c true via \c GMX_GPU_SYCL_NO_SYNCHRONIZE environment variable will
 165      * immediately return from \ref enqueueWaitEvent, without placing a barrier into the stream.
 166      */
 167     bool doNotSynchronizeBetweenStreams_;
 168 };
 169
 170 #endif // !defined DOXYGEN
 171
 172 #endif // GMX_GPU_UTILS_GPUEVENTSYNCHRONIZER_SYCL_H