d53552e3c2e4849d1b2fb8ea738d7274ad8cf90e
[alexxy/gromacs.git] / src / gromacs / gpu_utils / gputraits_sycl.h
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2018,2019,2020,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 #ifndef GMX_GPU_UTILS_GPUTRAITS_SYCL_H
36 #define GMX_GPU_UTILS_GPUTRAITS_SYCL_H
37
38 /*! \libinternal \file
39  *  \brief Declares the SYCL type traits.
40  *
41  *  \author Andrey Alekseenko <al42and@gmail.com>
42  *
43  * \inlibraryapi
44  * \ingroup module_gpu_utils
45  */
46
47 #include <cstddef>
48
49 #include "gromacs/gpu_utils/gmxsycl.h"
50 #include "gromacs/math/vectypes.h"
51
52 using DeviceTexture = void*;
53
54 //! \brief Single GPU call timing event, not used with SYCL
55 using CommandEvent = void*;
56
57 //! Convenience alias.
58 using float4 = cl::sycl::float4;
59
60 //! Convenience alias. Not using cl::sycl::float3 due to alignment issues.
61 using float3 = gmx::RVec;
62
63 //! Convenience alias for cl::sycl::float2
64 using float2 = cl::sycl::float2;
65
66 /*! \internal \brief
67  * GPU kernels scheduling description. This is same in OpenCL/CUDA.
68  * Provides reasonable defaults, one typically only needs to set the GPU stream
69  * and non-1 work sizes.
70  */
71 struct KernelLaunchConfig
72 {
73     //! Work groups (CUDA blocks) counts
74     size_t gridSize[3] = { 1, 1, 1 };
75     //! Per work group (CUDA block) thread counts
76     size_t blockSize[3] = { 1, 1, 1 };
77     //! Shared memory size in bytes
78     size_t sharedMemorySize = 0;
79 };
80
81 /*! \brief Sets whether device code can use arrays that are embedded in structs.
82  * \todo Probably can, must check
83  */
84 #define c_canEmbedBuffers false
85
86 #endif