cb3277b82f4c12e60f4dd74d16042ba37aed1bad
[alexxy/gromacs.git] / src / gromacs / gpu_utils / devicebuffer_sycl.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 #ifndef GMX_GPU_UTILS_DEVICEBUFFER_SYCL_H
36 #define GMX_GPU_UTILS_DEVICEBUFFER_SYCL_H
37
38 /*! \libinternal \file
39  *  \brief Implements the DeviceBuffer type and routines for SYCL.
40  *  Should only be included directly by the main DeviceBuffer file devicebuffer.h.
41  *  TODO: the intent is for DeviceBuffer to become a class.
42  *
43  *  \author Artem Zhmurov <zhmurov@gmail.com>
44  *  \author Erik Lindahl <erik.lindahl@gmail.com>
45  *  \author Andrey Alekseenko <al42and@gmail.com>
46  *
47  *  \inlibraryapi
48  */
49
50 #include <utility>
51
52 #include "gromacs/gpu_utils/device_context.h"
53 #include "gromacs/gpu_utils/device_stream.h"
54 #include "gromacs/gpu_utils/devicebuffer_datatype.h"
55 #include "gromacs/gpu_utils/gmxsycl.h"
56 #include "gromacs/gpu_utils/gpu_utils.h" //only for GpuApiCallBehavior
57 #include "gromacs/gpu_utils/gputraits_sycl.h"
58 #include "gromacs/utility/fatalerror.h"
59 #include "gromacs/utility/gmxassert.h"
60 #include "gromacs/utility/stringutil.h"
61
62 #ifndef DOXYGEN
63 template<typename T>
64 class DeviceBuffer<T>::ClSyclBufferWrapper : public cl::sycl::buffer<T, 1>
65 {
66     using cl::sycl::buffer<T, 1>::buffer; // Get all the constructors
67 };
68
69 template<typename T>
70 using ClSyclBufferWrapper = typename DeviceBuffer<T>::ClSyclBufferWrapper;
71
72 //! Constructor.
73 template<typename T>
74 DeviceBuffer<T>::DeviceBuffer() : buffer_(nullptr)
75 {
76 }
77
78 //! Destructor.
79 template<typename T>
80 DeviceBuffer<T>::~DeviceBuffer() = default;
81
82 //! Copy constructor (references the same underlying SYCL buffer).
83 template<typename T>
84 DeviceBuffer<T>::DeviceBuffer(DeviceBuffer<T> const& src)
85 {
86     if (src.buffer_)
87     {
88         buffer_ = std::make_unique<ClSyclBufferWrapper>(*src.buffer_);
89     }
90     else
91     {
92         buffer_ = nullptr;
93     }
94 }
95
96 //! Move constructor.
97 template<typename T>
98 DeviceBuffer<T>::DeviceBuffer(DeviceBuffer<T>&& src) noexcept = default;
99
100 //! Copy assignment (references the same underlying SYCL buffer).
101 template<typename T>
102 DeviceBuffer<T>& DeviceBuffer<T>::operator=(DeviceBuffer<T> const& src)
103 {
104     if (src.buffer_)
105     {
106         buffer_ = std::make_unique<ClSyclBufferWrapper>(*src.buffer_);
107     }
108     else
109     {
110         buffer_.reset(nullptr);
111     }
112     return *this;
113 }
114
115 //! Move assignment.
116 template<typename T>
117 DeviceBuffer<T>& DeviceBuffer<T>::operator=(DeviceBuffer<T>&& src) noexcept = default;
118
119 /*! \brief Dummy assignment operator to allow compilation of some cross-platform code.
120  *
121  * A hacky way to make SYCL implementation of DeviceBuffer compatible with details of CUDA and
122  * OpenCL implementations.
123  *
124  * \todo Should be removed after DeviceBuffer refactoring.
125  *
126  * \tparam T Type of buffer content.
127  * \param nullPtr \c std::nullptr. Not possible to assign any other pointers.
128  */
129 template<typename T>
130 DeviceBuffer<T>& DeviceBuffer<T>::operator=(std::nullptr_t nullPtr)
131 {
132     buffer_.reset(nullPtr);
133     return *this;
134 }
135
136
137 namespace gmx::internal
138 {
139 //! Shorthand alias to create a placeholder SYCL accessor with chosen data type and access mode.
140 template<class T, cl::sycl::access::mode mode>
141 using PlaceholderAccessor =
142         cl::sycl::accessor<T, 1, mode, cl::sycl::access::target::global_buffer, cl::sycl::access::placeholder::true_t>;
143 } // namespace gmx::internal
144
145 /** \brief
146  * Thin wrapper around placeholder accessor that allows implicit construction from \c DeviceBuffer.
147  *
148  * "Placeholder accessor" is an indicator of the intent to create an accessor for certain buffer
149  * of a certain type, that is not yet bound to a specific command group handler (device). Such
150  * accessors can be created outside SYCL kernels, which is helpful if we want to pass them as
151  * function arguments.
152  *
153  * \tparam T Type of buffer content.
154  * \tparam mode Access mode.
155  */
156 template<class T, cl::sycl::access::mode mode>
157 class DeviceAccessor : public gmx::internal::PlaceholderAccessor<T, mode>
158 {
159 public:
160     // Inherit all the constructors
161     using gmx::internal::PlaceholderAccessor<T, mode>::PlaceholderAccessor;
162     //! Construct Accessor from DeviceBuffer (must be initialized)
163     DeviceAccessor(DeviceBuffer<T>& buffer) :
164         gmx::internal::PlaceholderAccessor<T, mode>(getSyclBuffer(buffer))
165     {
166     }
167     //! Construct read-only Accessor from a const DeviceBuffer (must be initialized)
168     DeviceAccessor(const DeviceBuffer<T>& buffer) :
169         gmx::internal::PlaceholderAccessor<T, mode>(getSyclBuffer(const_cast<DeviceBuffer<T>&>(buffer)))
170     {
171         /* There were some discussions about making it possible to create read-only sycl::accessor
172          * from a const sycl::buffer (https://github.com/KhronosGroup/SYCL-Docs/issues/10), but
173          * it did not make it into the SYCL2020 standard. So, we have to use const_cast above */
174         /* Using static_assert to ensure that only mode::read accessors can be created from a
175          * const DeviceBuffer. static_assert provides better error messages than std::enable_if. */
176         static_assert(mode == cl::sycl::access::mode::read,
177                       "Can not create non-read-only accessor from a const DeviceBuffer");
178     }
179
180 private:
181     //! Helper function to get sycl:buffer object from DeviceBuffer wrapper, with a sanity check.
182     static inline cl::sycl::buffer<T, 1>& getSyclBuffer(DeviceBuffer<T>& buffer)
183     {
184         GMX_ASSERT(bool(buffer), "Trying to construct accessor from an uninitialized buffer");
185         return *buffer.buffer_;
186     }
187 };
188
189 namespace gmx::internal
190 {
191 //! A "blackhole" class to be used when we want to ignore an argument to a function.
192 struct EmptyClassThatIgnoresConstructorArguments
193 {
194     template<class... Args>
195     [[maybe_unused]] EmptyClassThatIgnoresConstructorArguments(Args&&... /*args*/)
196     {
197     }
198     //! Allow casting to nullptr
199     constexpr operator std::nullptr_t() const { return nullptr; }
200 };
201 } // namespace gmx::internal
202
203 /** \brief
204  * Helper class to be used as function argument. Will either correspond to a device accessor, or an empty class.
205  *
206  * Example usage:
207  * \code
208     template <bool doFoo>
209     void getBarKernel(handler& cgh, OptionalAccessor<float, mode::read, doFoo> a_fooPrms)
210     {
211         if constexpr (doFoo)
212             cgh.require(a_fooPrms);
213         // Can only use a_fooPrms if doFoo == true
214     }
215
216     template <bool doFoo>
217     void callBar(DeviceBuffer<float> b_fooPrms)
218     {
219         // If doFoo is false, b_fooPrms will be ignored (can be not initialized).
220         // Otherwise, an accessor will be built (b_fooPrms must be a valid buffer).
221         auto kernel = getBarKernel<doFoo>(b_fooPrms);
222         // If the accessor in not enabled, anything can be passed as its ctor argument.
223         auto kernel2 = getBarKernel<false>(nullptr_t);
224     }
225  * \endcode
226  *
227  * \tparam T Data type of the underlying buffer
228  * \tparam mode Access mode of the accessor
229  * \tparam enabled Compile-time flag indicating whether we want to actually create an accessor.
230  */
231 template<class T, cl::sycl::access::mode mode, bool enabled>
232 using OptionalAccessor =
233         std::conditional_t<enabled, DeviceAccessor<T, mode>, gmx::internal::EmptyClassThatIgnoresConstructorArguments>;
234
235 #endif // #ifndef DOXYGEN
236
237 /*! \brief Check the validity of the device buffer.
238  *
239  * Checks if the buffer is valid and if its allocation is big enough.
240  *
241  * \param[in] buffer        Device buffer to be checked.
242  * \param[in] requiredSize  Number of elements that the buffer will have to accommodate.
243  *
244  * \returns Whether the device buffer exists and has enough capacity.
245  */
246 template<typename T>
247 static gmx_unused bool checkDeviceBuffer(const DeviceBuffer<T>& buffer, int requiredSize)
248 {
249     return buffer.buffer_ && (static_cast<int>(buffer.buffer_->get_count()) >= requiredSize);
250 }
251
252 /*! \libinternal \brief
253  * Allocates a device-side buffer.
254  * It is currently a caller's responsibility to call it only on not-yet allocated buffers.
255  *
256  * \tparam        ValueType            Raw value type of the \p buffer.
257  * \param[in,out] buffer               Pointer to the device-side buffer.
258  * \param[in]     numValues            Number of values to accommodate.
259  * \param[in]     deviceContext        The buffer's device context-to-be.
260  */
261 template<typename ValueType>
262 void allocateDeviceBuffer(DeviceBuffer<ValueType>* buffer, size_t numValues, const DeviceContext& deviceContext)
263 {
264     /* SYCL does not require binding buffer to a specific context or device. The ::context_bound
265      * property only enforces the use of only given context, and possibly offers some optimizations */
266     const cl::sycl::property_list bufferProperties{ cl::sycl::property::buffer::context_bound(
267             deviceContext.context()) };
268     buffer->buffer_.reset(
269             new ClSyclBufferWrapper<ValueType>(cl::sycl::range<1>(numValues), bufferProperties));
270 }
271
272 /*! \brief
273  * Frees a device-side buffer.
274  * This does not reset separately stored size/capacity integers,
275  * as this is planned to be a destructor of DeviceBuffer as a proper class,
276  * and no calls on \p buffer should be made afterwards.
277  *
278  * \param[in] buffer  Pointer to the buffer to free.
279  */
280 template<typename ValueType>
281 void freeDeviceBuffer(DeviceBuffer<ValueType>* buffer)
282 {
283     buffer->buffer_.reset(nullptr);
284 }
285
286 /*! \brief
287  * Performs the host-to-device data copy, synchronous or asynchronously on request.
288  *
289  * Unlike in CUDA and OpenCL, synchronous call does not guarantee that all previously
290  * submitted operations are complete, only the ones that are required for \p buffer consistency.
291  *
292  * \tparam        ValueType            Raw value type of the \p buffer.
293  * \param[in,out] buffer               Pointer to the device-side buffer.
294  * \param[in]     hostBuffer           Pointer to the raw host-side memory, also typed \p ValueType.
295  * \param[in]     startingOffset       Offset (in values) at the device-side buffer to copy into.
296  * \param[in]     numValues            Number of values to copy.
297  * \param[in]     deviceStream         GPU stream to perform asynchronous copy in.
298  * \param[in]     transferKind         Copy type: synchronous or asynchronous.
299  * \param[out]    timingEvent          A pointer to the H2D copy timing event to be filled in.
300  *                                     Ignored in SYCL.
301  */
302 template<typename ValueType>
303 void copyToDeviceBuffer(DeviceBuffer<ValueType>* buffer,
304                         const ValueType*         hostBuffer,
305                         size_t                   startingOffset,
306                         size_t                   numValues,
307                         const DeviceStream&      deviceStream,
308                         GpuApiCallBehavior       transferKind,
309                         CommandEvent* gmx_unused timingEvent)
310 {
311     if (numValues == 0)
312     {
313         return; // such calls are actually made with empty domains
314     }
315     GMX_ASSERT(buffer, "needs a buffer pointer");
316     GMX_ASSERT(hostBuffer, "needs a host buffer pointer");
317
318     GMX_ASSERT(checkDeviceBuffer(*buffer, startingOffset + numValues),
319                "buffer too small or not initialized");
320
321     cl::sycl::buffer<ValueType>& syclBuffer = *buffer->buffer_;
322
323     cl::sycl::event ev = deviceStream.stream().submit([&](cl::sycl::handler& cgh) {
324         /* Here and elsewhere in this file, accessor constructor is user instead of a more common
325          * buffer::get_access, since the compiler (icpx 2021.1-beta09) occasionally gets confused
326          * by all the overloads */
327         auto d_bufferAccessor = cl::sycl::accessor<ValueType, 1, cl::sycl::access::mode::discard_write>{
328             syclBuffer, cgh, cl::sycl::range(numValues), cl::sycl::id(startingOffset)
329         };
330         cgh.copy(hostBuffer, d_bufferAccessor);
331     });
332     if (transferKind == GpuApiCallBehavior::Sync)
333     {
334         ev.wait_and_throw();
335     }
336 }
337
338 /*! \brief
339  * Performs the device-to-host data copy, synchronous or asynchronously on request.
340  *
341  * Unlike in CUDA and OpenCL, synchronous call does not guarantee that all previously
342  * submitted operations are complete, only the ones that are required for \p buffer consistency.
343  *
344  * \tparam        ValueType            Raw value type of the \p buffer.
345  * \param[in,out] hostBuffer           Pointer to the raw host-side memory, also typed \p ValueType
346  * \param[in]     buffer               Pointer to the device-side buffer.
347  * \param[in]     startingOffset       Offset (in values) at the device-side buffer to copy from.
348  * \param[in]     numValues            Number of values to copy.
349  * \param[in]     deviceStream         GPU stream to perform asynchronous copy in.
350  * \param[in]     transferKind         Copy type: synchronous or asynchronous.
351  * \param[out]    timingEvent          A pointer to the H2D copy timing event to be filled in.
352  *                                     Ignored in SYCL.
353  */
354 template<typename ValueType>
355 void copyFromDeviceBuffer(ValueType*               hostBuffer,
356                           DeviceBuffer<ValueType>* buffer,
357                           size_t                   startingOffset,
358                           size_t                   numValues,
359                           const DeviceStream&      deviceStream,
360                           GpuApiCallBehavior       transferKind,
361                           CommandEvent* gmx_unused timingEvent)
362 {
363     if (numValues == 0)
364     {
365         return; // such calls are actually made with empty domains
366     }
367     GMX_ASSERT(buffer, "needs a buffer pointer");
368     GMX_ASSERT(hostBuffer, "needs a host buffer pointer");
369
370     GMX_ASSERT(checkDeviceBuffer(*buffer, startingOffset + numValues),
371                "buffer too small or not initialized");
372
373     cl::sycl::buffer<ValueType>& syclBuffer = *buffer->buffer_;
374
375     cl::sycl::event ev = deviceStream.stream().submit([&](cl::sycl::handler& cgh) {
376         const auto d_bufferAccessor = cl::sycl::accessor<ValueType, 1, cl::sycl::access::mode::read>{
377             syclBuffer, cgh, cl::sycl::range(numValues), cl::sycl::id(startingOffset)
378         };
379         cgh.copy(d_bufferAccessor, hostBuffer);
380     });
381     if (transferKind == GpuApiCallBehavior::Sync)
382     {
383         ev.wait_and_throw();
384     }
385 }
386
387 /*! \brief
388  * Performs the device-to-device data copy, synchronous or asynchronously on request.
389  *
390  * \tparam        ValueType                Raw value type of the \p buffer.
391  */
392 template<typename ValueType>
393 void copyBetweenDeviceBuffers(DeviceBuffer<ValueType>* /* destinationDeviceBuffer */,
394                               DeviceBuffer<ValueType>* /* sourceDeviceBuffer */,
395                               size_t /* numValues */,
396                               const DeviceStream& /* deviceStream */,
397                               GpuApiCallBehavior /* transferKind */,
398                               CommandEvent* /*timingEvent*/)
399 {
400     // SYCL-TODO
401     gmx_fatal(FARGS, "D2D copy stub was called. Not yet implemented in SYCL.");
402 }
403
404
405 namespace gmx::internal
406 {
407 /*! \brief Helper function to clear device buffer.
408  *
409  * Not applicable to GROMACS's Float3 (a.k.a. gmx::RVec) and other custom types.
410  * From SYCL specs: "T must be a scalar value or a SYCL vector type."
411  */
412 template<typename ValueType>
413 cl::sycl::event fillSyclBufferWithNull(cl::sycl::buffer<ValueType, 1>& buffer,
414                                        size_t                          startingOffset,
415                                        size_t                          numValues,
416                                        cl::sycl::queue                 queue)
417 {
418     using cl::sycl::access::mode;
419     const cl::sycl::range<1> range(numValues);
420     const cl::sycl::id<1>    offset(startingOffset);
421     const ValueType pattern = ValueType(0); // SYCL vectors support initialization by scalar
422
423     return queue.submit([&](cl::sycl::handler& cgh) {
424         auto d_bufferAccessor =
425                 cl::sycl::accessor<ValueType, 1, mode::discard_write>{ buffer, cgh, range, offset };
426         cgh.fill(d_bufferAccessor, pattern);
427     });
428 }
429
430 //! \brief Helper function to clear device buffer of type Float3.
431 template<>
432 inline cl::sycl::event fillSyclBufferWithNull(cl::sycl::buffer<Float3, 1>& buffer,
433                                               size_t                       startingOffset,
434                                               size_t                       numValues,
435                                               cl::sycl::queue              queue)
436 {
437     constexpr bool usingHipSycl =
438 #ifdef __HIPSYCL__
439             true;
440 #else
441             false;
442 #endif
443
444
445     if constexpr (usingHipSycl)
446     {
447         // hipSYCL does not support reinterpret but allows using Float3 directly.
448         using cl::sycl::access::mode;
449         const cl::sycl::range<1> range(numValues);
450         const cl::sycl::id<1>    offset(startingOffset);
451         const Float3             pattern{ 0, 0, 0 };
452
453         return queue.submit([&](cl::sycl::handler& cgh) {
454             auto d_bufferAccessor =
455                     cl::sycl::accessor<Float3, 1, mode::discard_write>{ buffer, cgh, range, offset };
456             cgh.fill(d_bufferAccessor, pattern);
457         });
458     }
459     else // When not using hipSYCL, reinterpret as a flat float array
460     {
461 #ifndef __HIPSYCL__
462         cl::sycl::buffer<float, 1> bufferAsFloat = buffer.reinterpret<float, 1>(buffer.get_count() * DIM);
463         return fillSyclBufferWithNull<float>(
464                 bufferAsFloat, startingOffset * DIM, numValues * DIM, std::move(queue));
465 #endif
466     }
467 }
468
469 } // namespace gmx::internal
470
471 /*! \brief
472  * Clears the device buffer asynchronously.
473  *
474  * \tparam        ValueType       Raw value type of the \p buffer.
475  * \param[in,out] buffer          Pointer to the device-side buffer.
476  * \param[in]     startingOffset  Offset (in values) at the device-side buffer to start clearing at.
477  * \param[in]     numValues       Number of values to clear.
478  * \param[in]     deviceStream    GPU stream.
479  */
480 template<typename ValueType>
481 void clearDeviceBufferAsync(DeviceBuffer<ValueType>* buffer,
482                             size_t                   startingOffset,
483                             size_t                   numValues,
484                             const DeviceStream&      deviceStream)
485 {
486     if (numValues == 0)
487     {
488         return;
489     }
490     GMX_ASSERT(buffer, "needs a buffer pointer");
491
492     GMX_ASSERT(checkDeviceBuffer(*buffer, startingOffset + numValues),
493                "buffer too small or not initialized");
494
495     cl::sycl::buffer<ValueType>& syclBuffer = *(buffer->buffer_);
496
497     gmx::internal::fillSyclBufferWithNull<ValueType>(
498             syclBuffer, startingOffset, numValues, deviceStream.stream());
499 }
500
501 /*! \brief Create a texture object for an array of type ValueType.
502  *
503  * Creates the device buffer and copies read-only data for an array of type ValueType.
504  * Like OpenCL, does not really do anything with textures, simply creates a buffer
505  * and initializes it.
506  *
507  * \tparam      ValueType      Raw data type.
508  *
509  * \param[out]  deviceBuffer   Device buffer to store data in.
510  * \param[in]   hostBuffer     Host buffer to get date from.
511  * \param[in]   numValues      Number of elements in the buffer.
512  * \param[in]   deviceContext  GPU device context.
513  */
514 template<typename ValueType>
515 void initParamLookupTable(DeviceBuffer<ValueType>* deviceBuffer,
516                           DeviceTexture* /* deviceTexture */,
517                           const ValueType*     hostBuffer,
518                           int                  numValues,
519                           const DeviceContext& deviceContext)
520 {
521     GMX_ASSERT(hostBuffer, "Host buffer should be specified.");
522     GMX_ASSERT(deviceBuffer, "Device buffer should be specified.");
523
524     /* Constructing buffer with cl::sycl::buffer(T* data, size_t size) will take ownership
525      * of this memory region making it unusable, which might lead to side-effects.
526      * On the other hand, cl::sycl::buffer(InputIterator<T> begin, InputIterator<T> end) will
527      * initialize the buffer without affecting ownership of the memory, although
528      * it will consume extra memory on host. */
529     const cl::sycl::property_list bufferProperties{ cl::sycl::property::buffer::context_bound(
530             deviceContext.context()) };
531     deviceBuffer->buffer_.reset(new ClSyclBufferWrapper<ValueType>(
532             hostBuffer, hostBuffer + numValues, bufferProperties));
533 }
534
535 /*! \brief Release the OpenCL device buffer.
536  *
537  * \tparam        ValueType     Raw data type.
538  *
539  * \param[in,out] deviceBuffer  Device buffer to store data in.
540  */
541 template<typename ValueType>
542 void destroyParamLookupTable(DeviceBuffer<ValueType>* deviceBuffer, DeviceTexture* /* deviceTexture */)
543 {
544     deviceBuffer->buffer_.reset(nullptr);
545 }
546
547 #endif // GMX_GPU_UTILS_DEVICEBUFFER_SYCL_H