2 * This file is part of the GROMACS molecular simulation package.
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.
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.
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.
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.
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.
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.
35 /*! \libinternal \file
36 * \brief Declares DeviceEvent for all build configuraitons
38 * This header may be included from any build configuration and
39 * defers valid GPU declarations to headers valid only in such
40 * build configurations.
42 * \author Mark Abraham <mark.j.abraham@gmail.com>
45 #ifndef GMX_GPU_UTILS_DEVICE_EVENT_H
46 #define GMX_GPU_UTILS_DEVICE_EVENT_H
50 #include "gromacs/utility/exceptions.h"
52 #if !GMX_GPU || defined(DOXYGEN)
56 // [[noreturn]] attributes must be added to the methods, so it's
57 // easier to silence the warning here and avoid them appearing in
60 # pragma clang diagnostic push
61 # pragma clang diagnostic ignored "-Wmissing-noreturn"
67 DeviceEvent() = default;
68 // Disable copy, move, and assignment. Move can be allowed, but not needed yet.
69 DeviceEvent& operator=(const DeviceEvent&) = delete;
70 DeviceEvent(const DeviceEvent&) = delete;
71 DeviceEvent& operator=(DeviceEvent&&) = delete;
72 DeviceEvent(DeviceEvent&&) = delete;
74 /*! \brief Marks the synchronization point in the \p stream.
75 * Should be followed by waitForEvent().
77 inline void mark(const DeviceStream& /*deviceStream*/) // NOLINT readability-convert-member-functions-to-static
79 GMX_THROW(gmx::NotImplementedError("Not implemented for non-GPU build"));
81 //! Synchronizes the host thread on the marked event.
82 inline void wait() // NOLINT readability-convert-member-functions-to-static
84 GMX_THROW(gmx::NotImplementedError("Not implemented for non-GPU build"));
86 //! Checks the completion of the underlying event.
87 inline bool isReady() // NOLINT readability-convert-member-functions-to-static
89 GMX_THROW(gmx::NotImplementedError("Not implemented for non-GPU build"));
91 //! Enqueues a wait for the recorded event in stream \p stream
92 // NOLINTNEXTLINE readability-convert-member-functions-to-static
93 inline void enqueueWait(const DeviceStream& /*deviceStream*/)
95 GMX_THROW(gmx::NotImplementedError("Not implemented for non-GPU build"));
97 //! Checks whether this object encapsulates an underlying event.
98 inline bool isMarked() // NOLINT readability-convert-member-functions-to-static
100 GMX_THROW(gmx::NotImplementedError("Not implemented for non-GPU build"));
103 //! Reset the event (not needed in CUDA)
104 // NOLINTNEXTLINE readability-convert-member-functions-to-static
105 inline void reset() // NOLINT readability-convert-member-functions-to-static
107 GMX_THROW(gmx::NotImplementedError("Not implemented for non-GPU build"));
112 # pragma clang diagnostic pop
116 # include "device_event.cuh"
118 # include "device_event_ocl.h"
120 # include "device_event_sycl.h"
123 #endif // GMX_GPU_UTILS_DEVICE_EVENT_H