src/gromacs/gpu_utils/oclutils.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014,2015,2016,2017,2018 by the GROMACS development team.
   5  * Copyright (c) 2019,2020, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \libinternal \file
  37  *  \brief Declare utility routines for OpenCL
  38  *
  39  *  \author Anca Hamuraru <anca@streamcomputing.eu>
  40  *  \inlibraryapi
  41  */
  42 #ifndef GMX_GPU_UTILS_OCLUTILS_H
  43 #define GMX_GPU_UTILS_OCLUTILS_H
  44
  45 #include <string>
  46
  47 #include "gromacs/gpu_utils/device_context.h"
  48 #include "gromacs/gpu_utils/device_stream.h"
  49 #include "gromacs/gpu_utils/gmxopencl.h"
  50 #include "gromacs/gpu_utils/gputraits_ocl.h"
  51 #include "gromacs/utility/exceptions.h"
  52 #include "gromacs/utility/gmxassert.h"
  53
  54 enum class GpuApiCallBehavior;
  55
  56 /*! \internal
  57  * \brief OpenCL GPU runtime data
  58  *
  59  * The device runtime data is meant to hold objects associated with a GROMACS rank's
  60  * (thread or process) use of a single device (multiple devices per rank is not
  61  * implemented). These objects should be constructed at ther point where a device
  62  * dets assigned to a rank and released at when this assignment is no longer valid
  63  * (i.e. at cleanup in the current implementation).
  64  *
  65  */
  66 struct gmx_device_runtime_data_t
  67 {
  68     //! OpenCL program
  69     cl_program program;
  70 };
  71
  72 /*! \brief Allocate host memory in malloc style */
  73 void pmalloc(void** h_ptr, size_t nbytes);
  74
  75 /*! \brief Free host memory in malloc style */
  76 void pfree(void* h_ptr);
  77
  78 /*! \brief Convert error code to diagnostic string */
  79 std::string ocl_get_error_string(cl_int error);
  80
  81 //! A debug checker to track cl_events being released correctly
  82 inline void ensureReferenceCount(const cl_event& event, unsigned int refCount)
  83 {
  84 #ifndef NDEBUG
  85     cl_int clError = clGetEventInfo(event, CL_EVENT_REFERENCE_COUNT, sizeof(refCount), &refCount, nullptr);
  86     GMX_ASSERT(CL_SUCCESS == clError, ocl_get_error_string(clError).c_str());
  87     GMX_ASSERT(refCount == refCount, "Unexpected reference count");
  88 #else
  89     GMX_UNUSED_VALUE(event);
  90     GMX_UNUSED_VALUE(refCount);
  91 #endif
  92 }
  93
  94 /*! \brief Pretend to synchronize an OpenCL stream (dummy implementation).
  95  *
  96  *  \returns  Not implemented in OpenCL.
  97  */
  98 static inline bool haveStreamTasksCompleted(const DeviceStream& /* deviceStream */)
  99 {
 100     GMX_RELEASE_ASSERT(false, "haveStreamTasksCompleted is not implemented for OpenCL");
 101     return false;
 102 }
 103
 104 /* Kernel launch helpers */
 105
 106 /*! \brief
 107  * A function for setting up a single OpenCL kernel argument.
 108  * This is the tail of the compile-time recursive function below.
 109  * It has to be seen by the compiler first.
 110  * As NB kernels might be using dynamic local memory as the last argument,
 111  * this function also manages that, using sharedMemorySize from \p config.
 112  *
 113  * \param[in]     kernel          Kernel function handle
 114  * \param[in]     config          Kernel configuration for launching
 115  * \param[in]     argIndex        Index of the current argument
 116  */
 117 void inline prepareGpuKernelArgument(cl_kernel kernel, const KernelLaunchConfig& config, size_t argIndex)
 118 {
 119     if (config.sharedMemorySize > 0)
 120     {
 121         cl_int gmx_used_in_debug clError =
 122                 clSetKernelArg(kernel, argIndex, config.sharedMemorySize, nullptr);
 123         GMX_ASSERT(CL_SUCCESS == clError, ocl_get_error_string(clError).c_str());
 124     }
 125 }
 126
 127 /*! \brief
 128  * Compile-time recursive function for setting up a single OpenCL kernel argument.
 129  * This function uses one kernel argument pointer \p argPtr to call clSetKernelArg(),
 130  * and calls itself on the next argument, eventually calling the tail function above.
 131  *
 132  * \tparam        CurrentArg      Type of the current argument
 133  * \tparam        RemainingArgs   Types of remaining arguments after the current one
 134  * \param[in]     kernel          Kernel function handle
 135  * \param[in]     config          Kernel configuration for launching
 136  * \param[in]     argIndex        Index of the current argument
 137  * \param[in]     argPtr          Pointer to the current argument
 138  * \param[in]     otherArgsPtrs   Pack of pointers to arguments remaining to process after the current one
 139  */
 140 template<typename CurrentArg, typename... RemainingArgs>
 141 void prepareGpuKernelArgument(cl_kernel                 kernel,
 142                               const KernelLaunchConfig& config,
 143                               size_t                    argIndex,
 144                               const CurrentArg*         argPtr,
 145                               const RemainingArgs*... otherArgsPtrs)
 146 {
 147     cl_int gmx_used_in_debug clError = clSetKernelArg(kernel, argIndex, sizeof(CurrentArg), argPtr);
 148     GMX_ASSERT(CL_SUCCESS == clError, ocl_get_error_string(clError).c_str());
 149
 150     // Assert on types not allowed to be passed to a kernel
 151     // (as per section 6.9 of the OpenCL spec).
 152     static_assert(!std::is_same<CurrentArg, bool>::value && !std::is_same<CurrentArg, size_t>::value
 153                           && !std::is_same<CurrentArg, ptrdiff_t>::value
 154                           && !std::is_same<CurrentArg, intptr_t>::value
 155                           && !std::is_same<CurrentArg, uintptr_t>::value,
 156                   "Invalid type passed to OpenCL kernel functions (see OpenCL spec section 6.9).");
 157
 158     prepareGpuKernelArgument(kernel, config, argIndex + 1, otherArgsPtrs...);
 159 }
 160
 161 /*! \brief
 162  * A wrapper function for setting up all the OpenCL kernel arguments.
 163  * Calls the recursive functions above.
 164  *
 165  * \tparam    Args            Types of all the kernel arguments
 166  * \param[in] kernel          Kernel function handle
 167  * \param[in] config          Kernel configuration for launching
 168  * \param[in] argsPtrs        Pointers to all the kernel arguments
 169  * \returns A handle for the prepared parameter pack to be used with launchGpuKernel() as the last argument
 170  * - currently always nullptr for OpenCL, as it manages kernel/arguments association by itself.
 171  */
 172 template<typename... Args>
 173 void* prepareGpuKernelArguments(cl_kernel kernel, const KernelLaunchConfig& config, const Args*... argsPtrs)
 174 {
 175     prepareGpuKernelArgument(kernel, config, 0, argsPtrs...);
 176     return nullptr;
 177 }
 178
 179 /*! \brief Launches the OpenCL kernel and handles the errors.
 180  *
 181  * \param[in] kernel          Kernel function handle
 182  * \param[in] config          Kernel configuration for launching
 183  * \param[in] deviceStream    GPU stream to launch kernel in
 184  * \param[in] timingEvent     Timing event, fetched from GpuRegionTimer
 185  * \param[in] kernelName      Human readable kernel description, for error handling only
 186  * \throws gmx::InternalError on kernel launch failure
 187  */
 188 inline void launchGpuKernel(cl_kernel                 kernel,
 189                             const KernelLaunchConfig& config,
 190                             const DeviceStream&       deviceStream,
 191                             CommandEvent*             timingEvent,
 192                             const char*               kernelName,
 193                             const void* /*kernelArgs*/)
 194 {
 195     const int       workDimensions   = 3;
 196     const size_t*   globalWorkOffset = nullptr;
 197     const size_t    waitListSize     = 0;
 198     const cl_event* waitList         = nullptr;
 199     size_t          globalWorkSize[3];
 200     for (int i = 0; i < workDimensions; i++)
 201     {
 202         globalWorkSize[i] = config.gridSize[i] * config.blockSize[i];
 203     }
 204     cl_int clError = clEnqueueNDRangeKernel(deviceStream.stream(), kernel, workDimensions,
 205                                             globalWorkOffset, globalWorkSize, config.blockSize,
 206                                             waitListSize, waitList, timingEvent);
 207     if (CL_SUCCESS != clError)
 208     {
 209         const std::string errorMessage = "GPU kernel (" + std::string(kernelName)
 210                                          + ") failed to launch: " + ocl_get_error_string(clError);
 211         GMX_THROW(gmx::InternalError(errorMessage));
 212     }
 213 }
 214
 215 #endif