Take over management of OpenCL context from PME and NBNXM
[alexxy/gromacs.git] / src / gromacs / nbnxm / gpu_data_mgmt.h
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2014,2015,2017,2018,2019,2020, 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 interface for GPU data transfer for NBNXN module
37  *
38  *  \author Szilard Pall <pall.szilard@gmail.com>
39  *  \author Mark Abraham <mark.j.abraham@gmail.com>
40  *  \ingroup module_nbnxm
41  *  \inlibraryapi
42  */
43
44 #ifndef GMX_NBNXN_GPU_DATA_MGMT_H
45 #define GMX_NBNXN_GPU_DATA_MGMT_H
46
47 #include <memory>
48
49 #include "gromacs/gpu_utils/devicebuffer_datatype.h"
50 #include "gromacs/gpu_utils/gpu_macros.h"
51 #include "gromacs/mdtypes/locality.h"
52
53 class DeviceContext;
54
55 struct NbnxmGpu;
56 struct gmx_gpu_info_t;
57 struct DeviceInformation;
58 struct gmx_wallclock_gpu_nbnxn_t;
59 struct nbnxn_atomdata_t;
60 struct NbnxnPairlistGpu;
61 struct PairlistParams;
62 struct interaction_const_t;
63
64 namespace Nbnxm
65 {
66
67 /** Initializes the data structures related to GPU nonbonded calculations. */
68 GPU_FUNC_QUALIFIER
69 NbnxmGpu* gpu_init(const DeviceInformation gmx_unused* deviceInfo,
70                    const DeviceContext gmx_unused& deviceContext,
71                    const interaction_const_t gmx_unused* ic,
72                    const PairlistParams gmx_unused& listParams,
73                    const nbnxn_atomdata_t gmx_unused* nbat,
74                    int gmx_unused rank,
75                    /* true if both local and non-local are done on GPU */
76                    bool gmx_unused bLocalAndNonlocal) GPU_FUNC_TERM_WITH_RETURN(nullptr);
77
78 /** Initializes pair-list data for GPU, called at every pair search step. */
79 GPU_FUNC_QUALIFIER
80 void gpu_init_pairlist(NbnxmGpu gmx_unused*          nb,
81                        const struct NbnxnPairlistGpu gmx_unused* h_nblist,
82                        gmx::InteractionLocality gmx_unused iloc) GPU_FUNC_TERM;
83
84 /** Initializes atom-data on the GPU, called at every pair search step. */
85 GPU_FUNC_QUALIFIER
86 void gpu_init_atomdata(NbnxmGpu gmx_unused* nb, const nbnxn_atomdata_t gmx_unused* nbat) GPU_FUNC_TERM;
87
88 /*! \brief Re-generate the GPU Ewald force table, resets rlist, and update the
89  *  electrostatic type switching to twin cut-off (or back) if needed.
90  */
91 GPU_FUNC_QUALIFIER
92 void gpu_pme_loadbal_update_param(const struct nonbonded_verlet_t gmx_unused* nbv,
93                                   const interaction_const_t gmx_unused* ic) GPU_FUNC_TERM;
94
95 /** Uploads shift vector to the GPU if the box is dynamic (otherwise just returns). */
96 GPU_FUNC_QUALIFIER
97 void gpu_upload_shiftvec(NbnxmGpu gmx_unused* nb, const nbnxn_atomdata_t gmx_unused* nbatom) GPU_FUNC_TERM;
98
99 /** Clears GPU outputs: nonbonded force, shift force and energy. */
100 GPU_FUNC_QUALIFIER
101 void gpu_clear_outputs(NbnxmGpu gmx_unused* nb, bool gmx_unused computeVirial) GPU_FUNC_TERM;
102
103 /** Frees all GPU resources used for the nonbonded calculations. */
104 GPU_FUNC_QUALIFIER
105 void gpu_free(NbnxmGpu gmx_unused* nb) GPU_FUNC_TERM;
106
107 /** Returns the GPU timings structure or NULL if GPU is not used or timing is off. */
108 GPU_FUNC_QUALIFIER
109 struct gmx_wallclock_gpu_nbnxn_t* gpu_get_timings(NbnxmGpu gmx_unused* nb)
110         GPU_FUNC_TERM_WITH_RETURN(nullptr);
111
112 /** Resets nonbonded GPU timings. */
113 GPU_FUNC_QUALIFIER
114 void gpu_reset_timings(struct nonbonded_verlet_t gmx_unused* nbv) GPU_FUNC_TERM;
115
116 /** Calculates the minimum size of proximity lists to improve SM load balance
117  *  with GPU non-bonded kernels. */
118 GPU_FUNC_QUALIFIER
119 int gpu_min_ci_balanced(NbnxmGpu gmx_unused* nb) GPU_FUNC_TERM_WITH_RETURN(-1);
120
121 /** Returns if analytical Ewald GPU kernels are used. */
122 GPU_FUNC_QUALIFIER
123 gmx_bool gpu_is_kernel_ewald_analytical(const NbnxmGpu gmx_unused* nb) GPU_FUNC_TERM_WITH_RETURN(FALSE);
124
125 /** Returns an opaque pointer to the GPU command stream
126  *  Note: CUDA only.
127  */
128 CUDA_FUNC_QUALIFIER
129 void* gpu_get_command_stream(NbnxmGpu gmx_unused* nb, gmx::InteractionLocality gmx_unused iloc)
130         CUDA_FUNC_TERM_WITH_RETURN(nullptr);
131
132 /** Returns an opaque pointer to the GPU coordinate+charge array
133  *  Note: CUDA only.
134  */
135 CUDA_FUNC_QUALIFIER
136 void* gpu_get_xq(NbnxmGpu gmx_unused* nb) CUDA_FUNC_TERM_WITH_RETURN(nullptr);
137
138 /** Returns an opaque pointer to the GPU force array
139  *  Note: CUDA only.
140  */
141 CUDA_FUNC_QUALIFIER
142 DeviceBuffer<gmx::RVec> gpu_get_f(NbnxmGpu gmx_unused* nb)
143         CUDA_FUNC_TERM_WITH_RETURN(DeviceBuffer<gmx::RVec>{});
144
145 /** Returns an opaque pointer to the GPU shift force array
146  *  Note: CUDA only.
147  */
148 CUDA_FUNC_QUALIFIER
149 DeviceBuffer<gmx::RVec> gpu_get_fshift(NbnxmGpu gmx_unused* nb)
150         CUDA_FUNC_TERM_WITH_RETURN(DeviceBuffer<gmx::RVec>{});
151
152 } // namespace Nbnxm
153
154 #endif