2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2019,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.
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 #ifndef GMX_GPU_UTILS_DEVICEBUFFER_DATATYPE_H
36 #define GMX_GPU_UTILS_DEVICEBUFFER_DATATYPE_H
38 /*! \libinternal \file
39 * \brief Declares the DeviceBuffer data type.
41 * \author Aleksei Iupinov <a.yupinov@gmail.com>
42 * \author Artem Zhmurov <zhmurov@gmail.com>
51 #include "gromacs/math/vectypes.h"
55 //! \brief A device-side buffer of ValueTypes
56 template<typename ValueType>
57 using DeviceBuffer = ValueType*;
61 # include "gromacs/gpu_utils/gputraits_ocl.h"
63 /*! \libinternal \brief
64 * A minimal cl_mem wrapper that remembers its allocation type.
65 * The only point is making template type deduction possible.
67 template<typename ValueType>
71 /*! \brief Underlying data
73 * \todo Make it nullptr when there are no snew()'s around
78 //! \brief An assignment operator - the purpose is to make allocation/zeroing work
79 TypedClMemory& operator=(cl_mem data)
84 //! \brief Returns underlying cl_mem transparently
85 operator cl_mem() { return data_; }
88 //! \libinternal \brief A device-side buffer of ValueTypes
89 template<typename ValueType>
90 using DeviceBuffer = TypedClMemory<ValueType>;
94 /*! \libinternal \brief
95 * A minimal wrapper around \c cl::sycl::buffer to hide it away and simplify compilation.
97 template<typename ValueType>
100 class ClSyclBufferWrapper;
101 std::unique_ptr<ClSyclBufferWrapper> buffer_;
105 DeviceBuffer(DeviceBuffer<ValueType> const& src);
106 DeviceBuffer(DeviceBuffer<ValueType>&& src) noexcept;
107 DeviceBuffer& operator=(DeviceBuffer<ValueType> const& src);
108 DeviceBuffer& operator=(DeviceBuffer<ValueType>&& src) noexcept;
110 //! Helper function to get the size in bytes of a single element
111 static constexpr size_t elementSize() { return sizeof(ValueType); }
113 // Both explicit and implicit casts to void* are used in MPI+CUDA code, this stub is necessary for compilation.
114 operator void*() const { throw; }
116 //! Allow implicit conversion to bool to check buffer status for compatibility with other implementations.
117 operator bool() const { return buffer_.get() != nullptr; }
119 //! An assignment operator to allow resetting buffer by assigning nullptr to it. Necessary for compilation.
120 DeviceBuffer& operator=(std::nullptr_t nullPtr);
123 // Must explicitly instantiate for some types.
124 extern template struct DeviceBuffer<gmx::RVec>;
128 //! \brief A device-side buffer of ValueTypes
129 template<typename ValueType>
130 using DeviceBuffer = void*;
134 #endif // GMX_GPU_UTILS_DEVICEBUFFER_DATATYPE_H