-/*
- * This file is part of the GROMACS molecular simulation package.
- *
- * Copyright (c) 2018,2019,2020,2021, by the GROMACS development team, led by
- * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
- * and including many others, as listed in the AUTHORS file in the
- * top-level source directory and at http://www.gromacs.org.
- *
- * GROMACS is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public License
- * as published by the Free Software Foundation; either version 2.1
- * of the License, or (at your option) any later version.
- *
- * GROMACS is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with GROMACS; if not, see
- * http://www.gnu.org/licenses, or write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
- *
- * If you want to redistribute modifications to GROMACS, please
- * consider that scientific software is very special. Version
- * control is crucial - bugs must be traceable. We will be happy to
- * consider code for inclusion in the official distribution, but
- * derived work must not be called official GROMACS. Details are found
- * in the README & COPYING files - if they are missing, get the
- * official version at http://www.gromacs.org.
- *
- * To help us fund GROMACS development, we humbly ask that you cite
- * the research papers on the package. Check out http://www.gromacs.org.
- */
-/*! \libinternal \file
- * \brief Implements a GpuEventSynchronizer class for CUDA.
- *
- * \author Aleksei Iupinov <a.yupinov@gmail.com>
- * \inlibraryapi
- */
-#ifndef GMX_GPU_UTILS_GPUEVENTSYNCHRONIZER_CUH
-#define GMX_GPU_UTILS_GPUEVENTSYNCHRONIZER_CUH
-
-#include "gromacs/gpu_utils/cudautils.cuh"
-#include "gromacs/gpu_utils/device_stream.h"
-#include "gromacs/gpu_utils/gputraits.cuh"
-#include "gromacs/utility/gmxassert.h"
-
-#ifndef DOXYGEN
-
-/*! \libinternal \brief
- * A class which allows for CPU thread to mark and wait for certain GPU stream execution point.
- * The event can be put into the stream with markEvent() and then later waited on with waitForEvent().
- * This can be repeated as necessary, but the current implementation does not allow waiting on
- * completed event more than once, expecting only exact pairs of markEvent(stream); waitForEvent().
- * The class generally attempts to track the correctness of its state transitions, but
- * please note that calling waitForEvent() right after the construction will succeed with CUDA but fail with OpenCL.
- *
- * Another possible mode of operation can be implemented if needed:
- * multiple calls to waitForEvent() after a single markEvent().
- * For this, only some small alterations to gpueventsynchronizer_ocl.h need to be made.
- * This was tested to work both with CUDA and NVidia OpenCL, but not with AMD/Intel OpenCL.
- */
-class GpuEventSynchronizer
-{
-public:
- GpuEventSynchronizer()
- {
- cudaError_t gmx_used_in_debug stat = cudaEventCreateWithFlags(&event_, cudaEventDisableTiming);
- GMX_RELEASE_ASSERT(stat == cudaSuccess,
- ("cudaEventCreate failed. " + gmx::getDeviceErrorString(stat)).c_str());
- }
- ~GpuEventSynchronizer()
- {
- cudaError_t gmx_used_in_debug stat = cudaEventDestroy(event_);
- GMX_RELEASE_ASSERT(stat == cudaSuccess,
- ("cudaEventDestroy failed. " + gmx::getDeviceErrorString(stat)).c_str());
- }
- //! No copying
- GpuEventSynchronizer(const GpuEventSynchronizer&) = delete;
- //! No assignment
- GpuEventSynchronizer& operator=(GpuEventSynchronizer&&) = delete;
- //! Moving is disabled but can be considered in the future if needed
- GpuEventSynchronizer(GpuEventSynchronizer&&) = delete;
-
- /*! \brief Marks the synchronization point in the \p stream.
- * Should be followed by waitForEvent().
- */
- inline void markEvent(const DeviceStream& deviceStream)
- {
- cudaError_t gmx_used_in_debug stat = cudaEventRecord(event_, deviceStream.stream());
- GMX_ASSERT(stat == cudaSuccess,
- ("cudaEventRecord failed. " + gmx::getDeviceErrorString(stat)).c_str());
- }
- /*! \brief Synchronizes the host thread on the marked event. */
- inline void waitForEvent()
- {
- cudaError_t gmx_used_in_debug stat = cudaEventSynchronize(event_);
- GMX_ASSERT(stat == cudaSuccess,
- ("cudaEventSynchronize failed. " + gmx::getDeviceErrorString(stat)).c_str());
- }
- /*! \brief Checks the completion of the underlying event and resets the object if it was. */
- inline bool isReady()
- {
- cudaError_t gmx_used_in_debug stat = cudaEventQuery(event_);
- GMX_ASSERT((stat == cudaSuccess) || (stat == cudaErrorNotReady),
- ("cudaEventQuery failed. " + gmx::getDeviceErrorString(stat)).c_str());
- return (stat == cudaSuccess);
- }
- /*! \brief Enqueues a wait for the recorded event in stream \p stream */
- inline void enqueueWaitEvent(const DeviceStream& deviceStream)
- {
- cudaError_t gmx_used_in_debug stat = cudaStreamWaitEvent(deviceStream.stream(), event_, 0);
- GMX_ASSERT(stat == cudaSuccess,
- ("cudaStreamWaitEvent failed. " + gmx::getDeviceErrorString(stat)).c_str());
- }
- //! Reset the event (not needed in CUDA)
- inline void reset() {}
-
-private:
- cudaEvent_t event_;
-};
-
-#endif
-
-#endif