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 /*! \brief Declare to OpenCL SDKs that we intend to use OpenCL API
  45    features that were deprecated in 2.0, so that they don't warn about
  46    it. */
  47 #define CL_USE_DEPRECATED_OPENCL_2_0_APIS
  48 #ifdef __APPLE__
  49 #    include <OpenCL/opencl.h>
  50 #else
  51 #    include <CL/opencl.h>
  52 #endif
  53
  54 #include <string>
  55
  56 /*! \brief OpenCL vendor IDs */
  57 typedef enum {
  58     OCL_VENDOR_NVIDIA = 0,
  59     OCL_VENDOR_AMD,
  60     OCL_VENDOR_INTEL,
  61     OCL_VENDOR_UNKNOWN
  62 } ocl_vendor_id_t;
  63
  64 /*! \internal
  65  * \brief OpenCL GPU device identificator
  66  *
  67  * An OpenCL device is identified by its ID.
  68  * The platform ID is also included for caching reasons.
  69  */
  70 typedef struct
  71 {
  72     cl_platform_id      ocl_platform_id; /**< Platform ID */
  73     cl_device_id        ocl_device_id;   /**< Device ID */
  74 } ocl_gpu_id_t;
  75
  76 /*! \internal
  77  * \brief OpenCL device information.
  78  *
  79  * The OpenCL device information is queried and set at detection and contains
  80  * both information about the device/hardware returned by the runtime as well
  81  * as additional data like support status.
  82  */
  83 struct gmx_device_info_t
  84 {
  85     ocl_gpu_id_t        ocl_gpu_id;          /**< device ID assigned at detection   */
  86     char                device_name[256];    /**< device name */
  87     char                device_version[256]; /**< device version */
  88     char                device_vendor[256];  /**< device vendor */
  89     int                 compute_units;       /**< number of compute units */
  90     int                 adress_bits;         /**< number of adress bits the device is capable of */
  91     int                 stat;                /**< device status takes values of e_gpu_detect_res_t */
  92     ocl_vendor_id_t     vendor_e;            /**< device vendor as defined by ocl_vendor_id_t */
  93 };
  94
  95 /*! \internal
  96  * \brief OpenCL GPU runtime data
  97  *
  98  * The device runtime data is meant to hold objects associated with a GROMACS rank's
  99  * (thread or process) use of a single device (multiple devices per rank is not
 100  * implemented). These objects should be constructed at ther point where a device
 101  * dets assigned to a rank and released at when this assignment is no longer valid
 102  * (i.e. at cleanup in the current implementation).
 103  *
 104  */
 105 struct gmx_device_runtime_data_t
 106 {
 107     cl_context context; /**< OpenCL context */
 108     cl_program program; /**< OpenCL program */
 109 };
 110
 111
 112 /*! \brief Launches asynchronous host to device memory copy. */
 113 int ocl_copy_H2D_async(cl_mem d_dest, void * h_src,
 114                        size_t offset, size_t bytes,
 115                        cl_command_queue command_queue,
 116                        cl_event *copy_event);
 117
 118 /*! \brief Launches asynchronous device to host memory copy. */
 119 int ocl_copy_D2H_async(void * h_dest, cl_mem d_src,
 120                        size_t offset, size_t bytes,
 121                        cl_command_queue command_queue,
 122                        cl_event *copy_event);
 123
 124 /*! \brief Launches synchronous host to device memory copy. */
 125 int ocl_copy_H2D(cl_mem d_dest, void * h_src,
 126                  size_t offset, size_t bytes,
 127                  cl_command_queue command_queue);
 128
 129 /*! \brief Allocate host memory in malloc style */
 130 void ocl_pmalloc(void **h_ptr, size_t nbytes);
 131
 132 /*! \brief Free host memory in malloc style */
 133 void ocl_pfree(void *h_ptr);
 134
 135 /*! \brief Convert error code to diagnostic string */
 136 std::string ocl_get_error_string(cl_int error);
 137
 138 #endif