2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2014,2015, 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.
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.
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.
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.
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.
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.
35 /*! \libinternal \file
36 * \brief Declare utility routines for OpenCL
38 * \author Anca Hamuraru <anca@streamcomputing.eu>
41 #ifndef GMX_GPU_UTILS_OCLUTILS_H
42 #define GMX_GPU_UTILS_OCLUTILS_H
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
47 #define CL_USE_DEPRECATED_OPENCL_2_0_APIS
49 # include <OpenCL/opencl.h>
51 # include <CL/opencl.h>
54 /*! \brief OpenCL vendor IDs */
56 OCL_VENDOR_NVIDIA = 0,
62 /*! \internal \brief OpenCL GPU device identificator
63 * An OpenCL device is identified by its ID.
64 * The platform ID is also included for caching reasons.
68 cl_platform_id ocl_platform_id; /**< Platform ID */
69 cl_device_id ocl_device_id; /**< Device ID */
72 /*! \internal \brief OpenCL GPU information
74 * \todo Move context and program outside this data structure.
75 * They are specific to a certain usage of the device (e.g. with/without OpenGL
76 * interop) and do not provide general device information as the data structure
79 * TODO Document fields
81 struct gmx_device_info_t
83 //! @cond Doxygen_Suppress
84 ocl_gpu_id_t ocl_gpu_id;
85 char device_name[256];
86 char device_version[256];
87 char device_vendor[256];
91 ocl_vendor_id_t vendor_e;
95 //! @endcond Doxygen_Suppress
100 /* Debugger callable function that prints the name of a kernel function pointer */
101 cl_int dbg_ocl_kernel_name(const cl_kernel kernel);
102 cl_int dbg_ocl_kernel_name_address(void* kernel);
106 /*! \brief Launches asynchronous host to device memory copy. */
107 int ocl_copy_H2D_async(cl_mem d_dest, void * h_src,
108 size_t offset, size_t bytes,
109 cl_command_queue command_queue,
110 cl_event *copy_event);
112 /*! \brief Launches asynchronous device to host memory copy. */
113 int ocl_copy_D2H_async(void * h_dest, cl_mem d_src,
114 size_t offset, size_t bytes,
115 cl_command_queue command_queue,
116 cl_event *copy_event);
118 /*! \brief Launches synchronous host to device memory copy. */
119 int ocl_copy_H2D(cl_mem d_dest, void * h_src,
120 size_t offset, size_t bytes,
121 cl_command_queue command_queue);
123 /*! \brief Allocate host memory in malloc style */
124 void ocl_pmalloc(void **h_ptr, size_t nbytes);
126 /*! \brief Free host memory in malloc style */
127 void ocl_pfree(void *h_ptr);