src/gromacs/gpu_utils/device_stream.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2020, 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 #ifndef GMX_GPU_UTILS_DEVICE_STREAM_H
  36 #define GMX_GPU_UTILS_DEVICE_STREAM_H
  37
  38 /*! \libinternal \file
  39  *
  40  * \brief Declarations for DeviceStream class.
  41  *
  42  * \author Artem Zhmurov <zhmurov@gmail.com>
  43  * \author Mark Abraham <mark.j.abraham@gmail.com>
  44  *
  45  * \ingroup module_gpu_utils
  46  * \inlibraryapi
  47  */
  48
  49 #include "config.h"
  50
  51 #if GMX_GPU_CUDA
  52 #    include <cuda_runtime.h>
  53
  54 #elif GMX_GPU_OPENCL
  55 #    include "gromacs/gpu_utils/gmxopencl.h"
  56 #endif
  57 #include "gromacs/utility/classhelpers.h"
  58
  59 struct DeviceInformation;
  60 class DeviceContext;
  61
  62 //! Enumeration describing the priority with which a stream operates.
  63 enum class DeviceStreamPriority : int
  64 {
  65     //! High-priority stream
  66     High,
  67     //! Normal-priority stream
  68     Normal,
  69     //! Conventional termination of the enumeration
  70     Count
  71 };
  72
  73 /*! \libinternal \brief Declaration of platform-agnostic device stream/queue.
  74  *
  75  * The command stream (or command queue) is a sequence of operations that are executed
  76  * in they order they were issued. Several streams may co-exist to represent concurency.
  77  * This class declares the interfaces, that are exposed to platform-agnostic code and
  78  * it should be implemented for each compute architecture (e.g. CUDA and OpenCL).
  79  *
  80  * Destruction of the \p DeviceStream calls the destructor of the underlying low-level
  81  * stream/queue, hence should only be called when the stream is no longer needed. To
  82  * prevent accidental stream destruction, while copying or moving a \p DeviceStream
  83  * object, copy and move constructors and copy and move assignments are not allowed
  84  * and the \p DeviceStream object should be passed as a pointer or constant reference.
  85  *
  86  */
  87 class DeviceStream
  88 {
  89 public:
  90     //! Default constructor
  91     DeviceStream();
  92     //! Destructor
  93     ~DeviceStream();
  94
  95     /*! \brief Initialize
  96      *
  97      * \param[in] deviceContext  Device context (not used in CUDA).
  98      * \param[in] priority       Stream priority: high or normal.
  99      * \param[in] useTiming      If the timing should be enabled (not used in CUDA).
 100      */
 101     void init(const DeviceContext& deviceContext, DeviceStreamPriority priority, bool useTiming);
 102
 103     /*! \brief Construct and init.
 104      *
 105      * \param[in] deviceContext  Device context (only used in OpenCL).
 106      * \param[in] priority       Stream priority: high or normal (only used in CUDA).
 107      * \param[in] useTiming      If the timing should be enabled (only used in OpenCL).
 108      */
 109     DeviceStream(const DeviceContext& deviceContext, DeviceStreamPriority priority, const bool useTiming)
 110     {
 111         init(deviceContext, priority, useTiming);
 112     }
 113
 114     /*! \brief Check if the underlying stream is valid.
 115      *
 116      *  \returns Whether the stream is valid (false in CPU-only builds).
 117      */
 118     bool isValid() const;
 119
 120     //! Synchronize the steam
 121     void synchronize() const;
 122
 123 #if GMX_GPU_CUDA
 124
 125     //! Getter
 126     cudaStream_t stream() const;
 127     //! Setter (temporary, will be removed in the follow-up)
 128     void setStream(cudaStream_t stream) { stream_ = stream; }
 129
 130 private:
 131     cudaStream_t stream_ = nullptr;
 132
 133 #elif GMX_GPU_OPENCL || defined DOXYGEN
 134
 135     //! Getter
 136     cl_command_queue stream() const;
 137     //! Setter (temporary, will be removed in the follow-up)
 138     void setStream(cl_command_queue stream) { stream_ = stream; }
 139
 140 private:
 141     cl_command_queue stream_ = nullptr;
 142
 143 #endif
 144
 145     GMX_DISALLOW_COPY_MOVE_AND_ASSIGN(DeviceStream);
 146 };
 147
 148 #endif // GMX_GPU_UTILS_DEVICE_STREAM_H