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 == GMX_GPU_OPENCL
  52 #    include "gromacs/gpu_utils/gmxopencl.h"
  53 #endif
  54 #include "gromacs/utility/classhelpers.h"
  55
  56 struct DeviceInformation;
  57 class DeviceContext;
  58
  59 //! Enumeration describing the priority with which a stream operates.
  60 enum class DeviceStreamPriority : int
  61 {
  62     //! High-priority stream
  63     High,
  64     //! Normal-priority stream
  65     Normal,
  66     //! Conventional termination of the enumeration
  67     Count
  68 };
  69
  70 // Stub for device context
  71 class DeviceStream
  72 {
  73 public:
  74     //! Default constructor
  75     DeviceStream();
  76     //! Destructor
  77     ~DeviceStream();
  78
  79     /*! \brief Initialize
  80      *
  81      * \param[in] deviceInfo     Platform-specific device information (only used in OpenCL).
  82      * \param[in] deviceContext  Device context (not used in CUDA).
  83      * \param[in] priority       Stream priority: high or normal.
  84      * \param[in] useTiming      If the timing should be enabled (not used in CUDA).
  85      */
  86     void init(const DeviceInformation& deviceInfo,
  87               const DeviceContext&     deviceContext,
  88               DeviceStreamPriority     priority,
  89               const bool               useTiming);
  90
  91     /*! \brief Construct and init.
  92      *
  93      * \param[in] deviceInfo     Platform-specific device information (only used in OpenCL).
  94      * \param[in] deviceContext  Device context (only used in OpenCL).
  95      * \param[in] priority       Stream priority: high or normal (only used in CUDA).
  96      * \param[in] useTiming      If the timing should be enabled (only used in OpenCL).
  97      */
  98     DeviceStream(const DeviceInformation& deviceInfo,
  99                  const DeviceContext&     deviceContext,
 100                  DeviceStreamPriority     priority,
 101                  const bool               useTiming)
 102     {
 103         init(deviceInfo, deviceContext, priority, useTiming);
 104     }
 105
 106     //! Synchronize the steam
 107     void synchronize() const;
 108
 109 #if GMX_GPU == GMX_GPU_CUDA
 110
 111     //! Getter
 112     cudaStream_t stream() const;
 113     //! Setter (temporary, will be removed in the follow-up)
 114     void setStream(cudaStream_t stream) { stream_ = stream; }
 115
 116 private:
 117     cudaStream_t stream_ = nullptr;
 118
 119 #elif GMX_GPU == GMX_GPU_OPENCL
 120
 121     //! Getter
 122     cl_command_queue stream() const;
 123     //! Setter (temporary, will be removed in the follow-up)
 124     void setStream(cl_command_queue stream) { stream_ = stream; }
 125
 126 private:
 127     cl_command_queue stream_ = nullptr;
 128
 129 #endif
 130
 131     GMX_DISALLOW_COPY_MOVE_AND_ASSIGN(DeviceStream);
 132 };
 133
 134 #endif // GMX_GPU_UTILS_DEVICE_STREAM_H