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, 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 /*! \libinternal \file
  36  *  \brief Declare utility routines for OpenCL
  37  *
  38  *  \author Anca Hamuraru <anca@streamcomputing.eu>
  39  *  \inlibraryapi
  40  */
  41 #ifndef GMX_GPU_UTILS_OCLUTILS_H
  42 #define GMX_GPU_UTILS_OCLUTILS_H
  43
  44 #include <string>
  45
  46 #include "gromacs/gpu_utils/gmxopencl.h"
  47 #include "gromacs/utility/gmxassert.h"
  48
  49 enum class GpuApiCallBehavior;
  50
  51 /*! \brief OpenCL vendor IDs */
  52 typedef enum {
  53     OCL_VENDOR_NVIDIA = 0,
  54     OCL_VENDOR_AMD,
  55     OCL_VENDOR_INTEL,
  56     OCL_VENDOR_UNKNOWN
  57 } ocl_vendor_id_t;
  58
  59 /*! \internal
  60  * \brief OpenCL GPU device identificator
  61  *
  62  * An OpenCL device is identified by its ID.
  63  * The platform ID is also included for caching reasons.
  64  */
  65 typedef struct
  66 {
  67     cl_platform_id      ocl_platform_id; /**< Platform ID */
  68     cl_device_id        ocl_device_id;   /**< Device ID */
  69 } ocl_gpu_id_t;
  70
  71 /*! \internal
  72  * \brief OpenCL device information.
  73  *
  74  * The OpenCL device information is queried and set at detection and contains
  75  * both information about the device/hardware returned by the runtime as well
  76  * as additional data like support status.
  77  */
  78 struct gmx_device_info_t
  79 {
  80     ocl_gpu_id_t        ocl_gpu_id;          /**< device ID assigned at detection   */
  81     char                device_name[256];    /**< device name */
  82     char                device_version[256]; /**< device version */
  83     char                device_vendor[256];  /**< device vendor */
  84     int                 compute_units;       /**< number of compute units */
  85     int                 adress_bits;         /**< number of adress bits the device is capable of */
  86     int                 stat;                /**< device status takes values of e_gpu_detect_res_t */
  87     ocl_vendor_id_t     vendor_e;            /**< device vendor as defined by ocl_vendor_id_t */
  88 };
  89
  90 /*! \internal
  91  * \brief OpenCL GPU runtime data
  92  *
  93  * The device runtime data is meant to hold objects associated with a GROMACS rank's
  94  * (thread or process) use of a single device (multiple devices per rank is not
  95  * implemented). These objects should be constructed at ther point where a device
  96  * dets assigned to a rank and released at when this assignment is no longer valid
  97  * (i.e. at cleanup in the current implementation).
  98  *
  99  */
 100 struct gmx_device_runtime_data_t
 101 {
 102     cl_context context; /**< OpenCL context */
 103     cl_program program; /**< OpenCL program */
 104 };
 105
 106 /*! \brief Launches synchronous or asynchronous device to host memory copy.
 107  *
 108  *  If copy_event is not NULL, on return it will contain an event object
 109  *  identifying this particular device to host operation. The event can further
 110  *  be used to queue a wait for this operation or to query profiling information.
 111  */
 112 int ocl_copy_D2H(void * h_dest, cl_mem d_src,
 113                  size_t offset, size_t bytes,
 114                  GpuApiCallBehavior transferKind,
 115                  cl_command_queue command_queue,
 116                  cl_event *copy_event);
 117
 118
 119 /*! \brief Launches asynchronous device to host memory copy. */
 120 int ocl_copy_D2H_async(void * h_dest, cl_mem d_src,
 121                        size_t offset, size_t bytes,
 122                        cl_command_queue command_queue,
 123                        cl_event *copy_event);
 124
 125 /*! \brief Launches synchronous or asynchronous host to device memory copy.
 126  *
 127  *  If copy_event is not NULL, on return it will contain an event object
 128  *  identifying this particular host to device operation. The event can further
 129  *  be used to queue a wait for this operation or to query profiling information.
 130  */
 131 int ocl_copy_H2D(cl_mem d_dest, void* h_src,
 132                  size_t offset, size_t bytes,
 133                  GpuApiCallBehavior transferKind,
 134                  cl_command_queue command_queue,
 135                  cl_event *copy_event);
 136
 137 /*! \brief Launches asynchronous host to device memory copy. */
 138 int ocl_copy_H2D_async(cl_mem d_dest, void * h_src,
 139                        size_t offset, size_t bytes,
 140                        cl_command_queue command_queue,
 141                        cl_event *copy_event);
 142
 143 /*! \brief Launches synchronous host to device memory copy. */
 144 int ocl_copy_H2D_sync(cl_mem d_dest, void * h_src,
 145                       size_t offset, size_t bytes,
 146                       cl_command_queue command_queue);
 147
 148 /*! \brief Allocate host memory in malloc style */
 149 void ocl_pmalloc(void **h_ptr, size_t nbytes);
 150
 151 /*! \brief Free host memory in malloc style */
 152 void ocl_pfree(void *h_ptr);
 153
 154 /*! \brief Convert error code to diagnostic string */
 155 std::string ocl_get_error_string(cl_int error);
 156
 157 /*! \brief Calls clFinish() in the stream \p s.
 158  *
 159  * \param[in] s stream to synchronize with
 160  */
 161 static inline void gpuStreamSynchronize(cl_command_queue s)
 162 {
 163     cl_int cl_error = clFinish(s);
 164     GMX_RELEASE_ASSERT(CL_SUCCESS == cl_error,
 165                        ("Error caught during clFinish:" + ocl_get_error_string(cl_error)).c_str());
 166 }
 167
 168 #endif