Apply clang-tidy-11 fixes to CUDA files
[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 };
199 } // namespace gmx::internal
200
201 /** \brief
202  * Helper class to be used as function argument. Will either correspond to a device accessor, or an empty class.
203  *
204  * Example usage:
205  * \code
206     template <bool doFoo>
207     void getBarKernel(handler& cgh, OptionalAccessor<float, mode::read, doFoo> a_fooPrms)
208     {
209         if constexpr (doFoo)
210             cgh.require(a_fooPrms);
211         // Can only use a_fooPrms if doFoo == true
212     }
213
214     template <bool doFoo>
215     void callBar(DeviceBuffer<float> b_fooPrms)
216     {
217         // If doFoo is false, b_fooPrms will be ignored (can be not initialized).
218         // Otherwise, an accessor will be built (b_fooPrms must be a valid buffer).
219         auto kernel = getBarKernel<doFoo>(b_fooPrms);
220         // If the accessor in not enabled, anything can be passed as its ctor argument.
221         auto kernel2 = getBarKernel<false>(nullptr_t);
222     }
223  * \endcode
224  *
225  * \tparam T Data type of the underlying buffer
226  * \tparam mode Access mode of the accessor
227  * \tparam enabled Compile-time flag indicating whether we want to actually create an accessor.
228  */
229 template<class T, cl::sycl::access::mode mode, bool enabled>
230 using OptionalAccessor =
231         std::conditional_t<enabled, DeviceAccessor<T, mode>, gmx::internal::EmptyClassThatIgnoresConstructorArguments>;
232
233 #endif // #ifndef DOXYGEN
234
235 /*! \brief Check the validity of the device buffer.
236  *
237  * Checks if the buffer is valid and if its allocation is big enough.
238  *
239  * \param[in] buffer        Device buffer to be checked.
240  * \param[in] requiredSize  Number of elements that the buffer will have to accommodate.
241  *
242  * \returns Whether the device buffer exists and has enough capacity.
243  */
244 template<typename T>
245 static gmx_unused bool checkDeviceBuffer(const DeviceBuffer<T>& buffer, int requiredSize)
246 {
247     return buffer.buffer_ && (static_cast<int>(buffer.buffer_->get_count()) >= requiredSize);
248 }
249
250 /*! \libinternal \brief
251  * Allocates a device-side buffer.
252  * It is currently a caller's responsibility to call it only on not-yet allocated buffers.
253  *
254  * \tparam        ValueType            Raw value type of the \p buffer.
255  * \param[in,out] buffer               Pointer to the device-side buffer.
256  * \param[in]     numValues            Number of values to accommodate.
257  * \param[in]     deviceContext        The buffer's device context-to-be.
258  */
259 template<typename ValueType>
260 void allocateDeviceBuffer(DeviceBuffer<ValueType>* buffer, size_t numValues, const DeviceContext& deviceContext)
261 {
262     /* SYCL does not require binding buffer to a specific context or device. The ::context_bound
263      * property only enforces the use of only given context, and possibly offers some optimizations */
264     const cl::sycl::property_list bufferProperties{ cl::sycl::property::buffer::context_bound(
265             deviceContext.context()) };
266     buffer->buffer_.reset(
267             new ClSyclBufferWrapper<ValueType>(cl::sycl::range<1>(numValues), bufferProperties));
268 }
269
270 /*! \brief
271  * Frees a device-side buffer.
272  * This does not reset separately stored size/capacity integers,
273  * as this is planned to be a destructor of DeviceBuffer as a proper class,
274  * and no calls on \p buffer should be made afterwards.
275  *
276  * \param[in] buffer  Pointer to the buffer to free.
277  */
278 template<typename ValueType>
279 void freeDeviceBuffer(DeviceBuffer<ValueType>* buffer)
280 {
281     buffer->buffer_.reset(nullptr);
282 }
283
284 /*! \brief
285  * Performs the host-to-device data copy, synchronous or asynchronously on request.
286  *
287  * Unlike in CUDA and OpenCL, synchronous call does not guarantee that all previously
288  * submitted operations are complete, only the ones that are required for \p buffer consistency.
289  *
290  * \tparam        ValueType            Raw value type of the \p buffer.
291  * \param[in,out] buffer               Pointer to the device-side buffer.
292  * \param[in]     hostBuffer           Pointer to the raw host-side memory, also typed \p ValueType.
293  * \param[in]     startingOffset       Offset (in values) at the device-side buffer to copy into.
294  * \param[in]     numValues            Number of values to copy.
295  * \param[in]     deviceStream         GPU stream to perform asynchronous copy in.
296  * \param[in]     transferKind         Copy type: synchronous or asynchronous.
297  * \param[out]    timingEvent          A pointer to the H2D copy timing event to be filled in.
298  *                                     Ignored in SYCL.
299  */
300 template<typename ValueType>
301 void copyToDeviceBuffer(DeviceBuffer<ValueType>* buffer,
302                         const ValueType*         hostBuffer,
303                         size_t                   startingOffset,
304                         size_t                   numValues,
305                         const DeviceStream&      deviceStream,
306                         GpuApiCallBehavior       transferKind,
307                         CommandEvent* gmx_unused timingEvent)
308 {
309     if (numValues == 0)
310     {
311         return; // such calls are actually made with empty domains
312     }
313     GMX_ASSERT(buffer, "needs a buffer pointer");
314     GMX_ASSERT(hostBuffer, "needs a host buffer pointer");
315
316     GMX_ASSERT(checkDeviceBuffer(*buffer, startingOffset + numValues),
317                "buffer too small or not initialized");
318
319     cl::sycl::buffer<ValueType>& syclBuffer = *buffer->buffer_;
320
321     cl::sycl::event ev = deviceStream.stream().submit([&](cl::sycl::handler& cgh) {
322         /* Here and elsewhere in this file, accessor constructor is user instead of a more common
323          * buffer::get_access, since the compiler (icpx 2021.1-beta09) occasionally gets confused
324          * by all the overloads */
325         auto d_bufferAccessor = cl::sycl::accessor<ValueType, 1, cl::sycl::access::mode::discard_write>{
326             syclBuffer, cgh, cl::sycl::range(numValues), cl::sycl::id(startingOffset)
327         };
328         cgh.copy(hostBuffer, d_bufferAccessor);
329     });
330     if (transferKind == GpuApiCallBehavior::Sync)
331     {
332         ev.wait_and_throw();
333     }
334 }
335
336 /*! \brief
337  * Performs the device-to-host data copy, synchronous or asynchronously on request.
338  *
339  * Unlike in CUDA and OpenCL, synchronous call does not guarantee that all previously
340  * submitted operations are complete, only the ones that are required for \p buffer consistency.
341  *
342  * \tparam        ValueType            Raw value type of the \p buffer.
343  * \param[in,out] hostBuffer           Pointer to the raw host-side memory, also typed \p ValueType
344  * \param[in]     buffer               Pointer to the device-side buffer.
345  * \param[in]     startingOffset       Offset (in values) at the device-side buffer to copy from.
346  * \param[in]     numValues            Number of values to copy.
347  * \param[in]     deviceStream         GPU stream to perform asynchronous copy in.
348  * \param[in]     transferKind         Copy type: synchronous or asynchronous.
349  * \param[out]    timingEvent          A pointer to the H2D copy timing event to be filled in.
350  *                                     Ignored in SYCL.
351  */
352 template<typename ValueType>
353 void copyFromDeviceBuffer(ValueType*               hostBuffer,
354                           DeviceBuffer<ValueType>* buffer,
355                           size_t                   startingOffset,
356                           size_t                   numValues,
357                           const DeviceStream&      deviceStream,
358                           GpuApiCallBehavior       transferKind,
359                           CommandEvent* gmx_unused timingEvent)
360 {
361     if (numValues == 0)
362     {
363         return; // such calls are actually made with empty domains
364     }
365     GMX_ASSERT(buffer, "needs a buffer pointer");
366     GMX_ASSERT(hostBuffer, "needs a host buffer pointer");
367
368     GMX_ASSERT(checkDeviceBuffer(*buffer, startingOffset + numValues),
369                "buffer too small or not initialized");
370
371     cl::sycl::buffer<ValueType>& syclBuffer = *buffer->buffer_;
372
373     cl::sycl::event ev = deviceStream.stream().submit([&](cl::sycl::handler& cgh) {
374         const auto d_bufferAccessor = cl::sycl::accessor<ValueType, 1, cl::sycl::access::mode::read>{
375             syclBuffer, cgh, cl::sycl::range(numValues), cl::sycl::id(startingOffset)
376         };
377         cgh.copy(d_bufferAccessor, hostBuffer);
378     });
379     if (transferKind == GpuApiCallBehavior::Sync)
380     {
381         ev.wait_and_throw();
382     }
383 }
384
385 /*! \brief
386  * Performs the device-to-device data copy, synchronous or asynchronously on request.
387  *
388  * \tparam        ValueType                Raw value type of the \p buffer.
389  */
390 template<typename ValueType>
391 void copyBetweenDeviceBuffers(DeviceBuffer<ValueType>* /* destinationDeviceBuffer */,
392                               DeviceBuffer<ValueType>* /* sourceDeviceBuffer */,
393                               size_t /* numValues */,
394                               const DeviceStream& /* deviceStream */,
395                               GpuApiCallBehavior /* transferKind */,
396                               CommandEvent* /*timingEvent*/)
397 {
398     // SYCL-TODO
399     gmx_fatal(FARGS, "D2D copy stub was called. Not yet implemented in SYCL.");
400 }
401
402
403 namespace gmx::internal
404 {
405 /*! \brief Helper function to clear device buffer.
406  *
407  * Not applicable to GROMACS's Float3 (a.k.a. gmx::RVec) and other custom types.
408  * From SYCL specs: "T must be a scalar value or a SYCL vector type."
409  */
410 template<typename ValueType>
411 cl::sycl::event fillSyclBufferWithNull(cl::sycl::buffer<ValueType, 1>& buffer,
412                                        size_t                          startingOffset,
413                                        size_t                          numValues,
414                                        cl::sycl::queue                 queue)
415 {
416     using cl::sycl::access::mode;
417     const cl::sycl::range<1> range(numValues);
418     const cl::sycl::id<1>    offset(startingOffset);
419     const ValueType pattern = ValueType(0); // SYCL vectors support initialization by scalar
420
421     return queue.submit([&](cl::sycl::handler& cgh) {
422         auto d_bufferAccessor =
423                 cl::sycl::accessor<ValueType, 1, mode::discard_write>{ buffer, cgh, range, offset };
424         cgh.fill(d_bufferAccessor, pattern);
425     });
426 }
427
428 //! \brief Helper function to clear device buffer of type Float3.
429 template<>
430 inline cl::sycl::event fillSyclBufferWithNull(cl::sycl::buffer<Float3, 1>& buffer,
431                                               size_t                       startingOffset,
432                                               size_t                       numValues,
433                                               cl::sycl::queue              queue)
434 {
435     constexpr bool usingHipSycl =
436 #ifdef __HIPSYCL__
437             true;
438 #else
439             false;
440 #endif
441
442
443     if constexpr (usingHipSycl)
444     {
445         // hipSYCL does not support reinterpret but allows using Float3 directly.
446         using cl::sycl::access::mode;
447         const cl::sycl::range<1> range(numValues);
448         const cl::sycl::id<1>    offset(startingOffset);
449         const Float3             pattern{ 0, 0, 0 };
450
451         return queue.submit([&](cl::sycl::handler& cgh) {
452             auto d_bufferAccessor =
453                     cl::sycl::accessor<Float3, 1, mode::discard_write>{ buffer, cgh, range, offset };
454             cgh.fill(d_bufferAccessor, pattern);
455         });
456     }
457     else // When not using hipSYCL, reinterpret as a flat float array
458     {
459         cl::sycl::buffer<float, 1> bufferAsFloat = buffer.reinterpret<float, 1>(buffer.get_count() * DIM);
460         return fillSyclBufferWithNull<float>(
461                 bufferAsFloat, startingOffset * DIM, numValues * DIM, std::move(queue));
462     }
463 }
464
465 } // namespace gmx::internal
466
467 /*! \brief
468  * Clears the device buffer asynchronously.
469  *
470  * \tparam        ValueType       Raw value type of the \p buffer.
471  * \param[in,out] buffer          Pointer to the device-side buffer.
472  * \param[in]     startingOffset  Offset (in values) at the device-side buffer to start clearing at.
473  * \param[in]     numValues       Number of values to clear.
474  * \param[in]     deviceStream    GPU stream.
475  */
476 template<typename ValueType>
477 void clearDeviceBufferAsync(DeviceBuffer<ValueType>* buffer,
478                             size_t                   startingOffset,
479                             size_t                   numValues,
480                             const DeviceStream&      deviceStream)
481 {
482     if (numValues == 0)
483     {
484         return;
485     }
486     GMX_ASSERT(buffer, "needs a buffer pointer");
487
488     GMX_ASSERT(checkDeviceBuffer(*buffer, startingOffset + numValues),
489                "buffer too small or not initialized");
490
491     cl::sycl::buffer<ValueType>& syclBuffer = *(buffer->buffer_);
492
493     gmx::internal::fillSyclBufferWithNull<ValueType>(
494             syclBuffer, startingOffset, numValues, deviceStream.stream());
495 }
496
497 /*! \brief Create a texture object for an array of type ValueType.
498  *
499  * Creates the device buffer and copies read-only data for an array of type ValueType.
500  * Like OpenCL, does not really do anything with textures, simply creates a buffer
501  * and initializes it.
502  *
503  * \tparam      ValueType      Raw data type.
504  *
505  * \param[out]  deviceBuffer   Device buffer to store data in.
506  * \param[in]   hostBuffer     Host buffer to get date from.
507  * \param[in]   numValues      Number of elements in the buffer.
508  * \param[in]   deviceContext  GPU device context.
509  */
510 template<typename ValueType>
511 void initParamLookupTable(DeviceBuffer<ValueType>* deviceBuffer,
512                           DeviceTexture* /* deviceTexture */,
513                           const ValueType*     hostBuffer,
514                           int                  numValues,
515                           const DeviceContext& deviceContext)
516 {
517     GMX_ASSERT(hostBuffer, "Host buffer should be specified.");
518     GMX_ASSERT(deviceBuffer, "Device buffer should be specified.");
519
520     /* Constructing buffer with cl::sycl::buffer(T* data, size_t size) will take ownership
521      * of this memory region making it unusable, which might lead to side-effects.
522      * On the other hand, cl::sycl::buffer(InputIterator<T> begin, InputIterator<T> end) will
523      * initialize the buffer without affecting ownership of the memory, although
524      * it will consume extra memory on host. */
525     const cl::sycl::property_list bufferProperties{ cl::sycl::property::buffer::context_bound(
526             deviceContext.context()) };
527     deviceBuffer->buffer_.reset(new ClSyclBufferWrapper<ValueType>(
528             hostBuffer, hostBuffer + numValues, bufferProperties));
529 }
530
531 /*! \brief Release the OpenCL device buffer.
532  *
533  * \tparam        ValueType     Raw data type.
534  *
535  * \param[in,out] deviceBuffer  Device buffer to store data in.
536  */
537 template<typename ValueType>
538 void destroyParamLookupTable(DeviceBuffer<ValueType>* deviceBuffer, DeviceTexture* /* deviceTexture */)
539 {
540     deviceBuffer->buffer_.reset(nullptr);
541 }
542
543 #endif // GMX_GPU_UTILS_DEVICEBUFFER_SYCL_H