src/gromacs/gpu_utils/device_event.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 Declares DeviceEvent for all build configuraitons
  37  *
  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.
  41  *
  42  *  \author Mark Abraham <mark.j.abraham@gmail.com>
  43  * \inlibraryapi
  44  */
  45 #ifndef GMX_GPU_UTILS_DEVICE_EVENT_H
  46 #define GMX_GPU_UTILS_DEVICE_EVENT_H
  47
  48 #include "config.h"
  49
  50 #include "gromacs/utility/exceptions.h"
  51
  52 #if !GMX_GPU || defined(DOXYGEN)
  53
  54 class DeviceStream;
  55
  56 // [[noreturn]] attributes must be added to the methods, so it's
  57 // easier to silence the warning here and avoid them appearing in
  58 // the Doxygen
  59 #    ifdef __clang__
  60 #        pragma clang diagnostic push
  61 #        pragma clang diagnostic ignored "-Wmissing-noreturn"
  62 #    endif
  63
  64 class DeviceEvent
  65 {
  66 public:
  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;
  73
  74     /*! \brief Marks the synchronization point in the \p stream.
  75      * Should be followed by waitForEvent().
  76      */
  77     inline void mark(const DeviceStream& /*deviceStream*/) // NOLINT readability-convert-member-functions-to-static
  78     {
  79         GMX_THROW(gmx::NotImplementedError("Not implemented for non-GPU build"));
  80     }
  81     //! Synchronizes the host thread on the marked event.
  82     inline void wait() // NOLINT readability-convert-member-functions-to-static
  83     {
  84         GMX_THROW(gmx::NotImplementedError("Not implemented for non-GPU build"));
  85     }
  86     //! Checks the completion of the underlying event.
  87     inline bool isReady() // NOLINT readability-convert-member-functions-to-static
  88     {
  89         GMX_THROW(gmx::NotImplementedError("Not implemented for non-GPU build"));
  90     }
  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*/)
  94     {
  95         GMX_THROW(gmx::NotImplementedError("Not implemented for non-GPU build"));
  96     }
  97     //! Checks whether the underlying event was marked.
  98     inline bool isMarked() const // NOLINT readability-convert-member-functions-to-static
  99     {
 100         GMX_THROW(gmx::NotImplementedError("Not implemented for non-GPU build"));
 101     }
 102
 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
 106     {
 107         GMX_THROW(gmx::NotImplementedError("Not implemented for non-GPU build"));
 108     }
 109 };
 110
 111 #    ifdef __clang__
 112 #        pragma clang diagnostic pop
 113 #    endif
 114
 115 #elif GMX_GPU_CUDA
 116 #    include "device_event.cuh"
 117 #elif GMX_GPU_OPENCL
 118 #    include "device_event_ocl.h"
 119 #elif GMX_GPU_SYCL
 120 #    include "device_event_sycl.h"
 121 #endif
 122
 123 #endif // GMX_GPU_UTILS_DEVICE_EVENT_H