src/gromacs/gpu_utils/sycl_kernel_utils.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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
  36 #ifndef GMX_GPU_UTILS_SYCL_KERNEL_UTILS_H
  37 #define GMX_GPU_UTILS_SYCL_KERNEL_UTILS_H
  38
  39 #include "gmxsycl.h"
  40
  41 /*! \file
  42  *  \brief SYCL kernel helper functions.
  43  *
  44  *  \author Andrey Alekseenko <al42and@gmail.com>
  45  */
  46
  47 /*! \brief Access mode to use for atomic accessors.
  48  *
  49  * Intel DPCPP compiler has \c sycl::atomic_ref, but has no \c sycl::atomic_fetch_add for floats.
  50  * However, \c atomic_ref can not be constructed from \c sycl::atomic, so we can not use
  51  * atomic accessors. Thus, we use \c mode::read_write accessors and \c atomic_ref.
  52  *
  53  * hipSYCL does not have \c sycl::atomic_ref, but has \c sycl::atomic_fetch_add for floats, which
  54  * requires using atomic accessors. Thus, we use \c mode::atomic accessors.
  55  *
  56  * The \ref atomicFetchAdd function could be used for doing operations on such accessors.
  57  */
  58 static constexpr auto mode_atomic = GMX_SYCL_DPCPP ? cl::sycl::access::mode::read_write :
  59                                                    /* GMX_SYCL_HIPSYCL */ cl::sycl::access::mode::atomic;
  60
  61 /*! \brief Convenience wrapper to do atomic addition to a global buffer.
  62  *
  63  * The implementation differences between DPCPP and hipSYCL are explained in \ref mode_atomic.
  64  */
  65 template<class IndexType>
  66 static inline void atomicFetchAdd(DeviceAccessor<float, mode_atomic> acc, const IndexType idx, const float val)
  67 {
  68 #if GMX_SYCL_DPCPP
  69     sycl_2020::atomic_ref<float, sycl_2020::memory_order::relaxed, sycl_2020::memory_scope::device, cl::sycl::access::address_space::global_space>
  70             fout_atomic(acc[idx]);
  71     fout_atomic.fetch_add(val);
  72 #elif GMX_SYCL_HIPSYCL
  73 #    ifdef SYCL_DEVICE_ONLY
  74     /* While there is support for float atomics on device, the host implementation uses
  75      * Clang's __atomic_fetch_add intrinsic, that, at least in Clang 11, does not support
  76      * floats. Luckily, we don't want to run on host. */
  77     acc[idx].fetch_add(val);
  78 #    else
  79     GMX_ASSERT(false, "hipSYCL host codepath not supported");
  80     GMX_UNUSED_VALUE(val);
  81     GMX_UNUSED_VALUE(acc);
  82     GMX_UNUSED_VALUE(idx);
  83 #    endif
  84 #endif
  85 }
  86
  87 namespace sycl_2020
  88 {
  89 #if GMX_SYCL_HIPSYCL
  90 __device__ static inline float shift_left(sycl_2020::sub_group, float var, sycl_2020::sub_group::linear_id_type delta)
  91 {
  92     // No sycl::sub_group::shift_left / shuffle_down in hipSYCL yet
  93 #    ifdef SYCL_DEVICE_ONLY
  94 #        if defined(HIPSYCL_PLATFORM_CUDA) && defined(__HIPSYCL_ENABLE_CUDA_TARGET__)
  95     static const unsigned int sc_cudaFullWarpMask = 0xffffffff;
  96     return __shfl_down_sync(sc_cudaFullWarpMask, var, delta);
  97 #        elif defined(HIPSYCL_PLATFORM_ROCM) && defined(__HIPSYCL_ENABLE_HIP_TARGET__)
  98     // Do we need more ifdefs? https://github.com/ROCm-Developer-Tools/HIP/issues/1491
  99     return __shfl_down(var, delta);
 100 #        else
 101 #            error "Unsupported hipSYCL target"
 102 #        endif
 103 #    else
 104     // Should never be called
 105     GMX_UNUSED_VALUE(var);
 106     GMX_UNUSED_VALUE(delta);
 107     assert(false);
 108     return NAN;
 109 #    endif
 110 }
 111 __host__ static inline float shift_left(sycl_2020::sub_group, float, sycl_2020::sub_group::linear_id_type)
 112 {
 113     // Should never be called
 114     assert(false);
 115     return NAN;
 116 }
 117 #elif GMX_SYCL_DPCPP
 118 static inline float shift_left(sycl_2020::sub_group sg, float var, sycl_2020::sub_group::linear_id_type delta)
 119 {
 120     return sg.shuffle_down(var, delta);
 121 }
 122 #endif
 123
 124 #if GMX_SYCL_HIPSYCL
 125 __device__ static inline float shift_right(sycl_2020::sub_group,
 126                                            float                                var,
 127                                            sycl_2020::sub_group::linear_id_type delta)
 128 {
 129     // No sycl::sub_group::shift_right / shuffle_up in hipSYCL yet
 130 #    ifdef SYCL_DEVICE_ONLY
 131 #        if defined(HIPSYCL_PLATFORM_CUDA) && defined(__HIPSYCL_ENABLE_CUDA_TARGET__)
 132     static const unsigned int sc_cudaFullWarpMask = 0xffffffff;
 133     return __shfl_up_sync(sc_cudaFullWarpMask, var, delta);
 134 #        elif defined(HIPSYCL_PLATFORM_ROCM) && defined(__HIPSYCL_ENABLE_HIP_TARGET__)
 135     // Do we need more ifdefs? https://github.com/ROCm-Developer-Tools/HIP/issues/1491
 136     return __shfl_up(var, delta);
 137 #        else
 138 #            error "Unsupported hipSYCL target"
 139 #        endif
 140 #    else
 141     // Should never be called
 142     assert(false);
 143     GMX_UNUSED_VALUE(var);
 144     GMX_UNUSED_VALUE(delta);
 145     return NAN;
 146 #    endif
 147 }
 148 __host__ static inline float shift_right(sycl_2020::sub_group, float, sycl_2020::sub_group::linear_id_type)
 149 {
 150     // Should never be called
 151     assert(false);
 152     return NAN;
 153 }
 154 #elif GMX_SYCL_DPCPP
 155 static inline float shift_right(sycl_2020::sub_group sg, float var, sycl_2020::sub_group::linear_id_type delta)
 156 {
 157     return sg.shuffle_up(var, delta);
 158 }
 159 #endif
 160 } // namespace sycl_2020
 161
 162 #endif /* GMX_GPU_UTILS_SYCL_KERNEL_UTILS_H */