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 class DeviceStream;
  55
  56 struct NbnxmGpu;
  57 struct gmx_gpu_info_t;
  58 struct DeviceInformation;
  59 struct gmx_wallclock_gpu_nbnxn_t;
  60 struct nbnxn_atomdata_t;
  61 struct NbnxnPairlistGpu;
  62 struct PairlistParams;
  63 struct interaction_const_t;
  64
  65 namespace Nbnxm
  66 {
  67
  68 /** Initializes the data structures related to GPU nonbonded calculations. */
  69 GPU_FUNC_QUALIFIER
  70 NbnxmGpu* gpu_init(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                    /* true if both local and non-local are done on GPU */
  75                    bool gmx_unused bLocalAndNonlocal) GPU_FUNC_TERM_WITH_RETURN(nullptr);
  76
  77 /** Initializes pair-list data for GPU, called at every pair search step. */
  78 GPU_FUNC_QUALIFIER
  79 void gpu_init_pairlist(NbnxmGpu gmx_unused*          nb,
  80                        const struct NbnxnPairlistGpu gmx_unused* h_nblist,
  81                        gmx::InteractionLocality gmx_unused iloc) GPU_FUNC_TERM;
  82
  83 /** Initializes atom-data on the GPU, called at every pair search step. */
  84 GPU_FUNC_QUALIFIER
  85 void gpu_init_atomdata(NbnxmGpu gmx_unused* nb, const nbnxn_atomdata_t gmx_unused* nbat) GPU_FUNC_TERM;
  86
  87 /*! \brief Re-generate the GPU Ewald force table, resets rlist, and update the
  88  *  electrostatic type switching to twin cut-off (or back) if needed.
  89  */
  90 GPU_FUNC_QUALIFIER
  91 void gpu_pme_loadbal_update_param(const struct nonbonded_verlet_t gmx_unused* nbv,
  92                                   const interaction_const_t gmx_unused* ic) GPU_FUNC_TERM;
  93
  94 /** Uploads shift vector to the GPU if the box is dynamic (otherwise just returns). */
  95 GPU_FUNC_QUALIFIER
  96 void gpu_upload_shiftvec(NbnxmGpu gmx_unused* nb, const nbnxn_atomdata_t gmx_unused* nbatom) GPU_FUNC_TERM;
  97
  98 /** Clears GPU outputs: nonbonded force, shift force and energy. */
  99 GPU_FUNC_QUALIFIER
 100 void gpu_clear_outputs(NbnxmGpu gmx_unused* nb, bool gmx_unused computeVirial) GPU_FUNC_TERM;
 101
 102 /** Frees all GPU resources used for the nonbonded calculations. */
 103 GPU_FUNC_QUALIFIER
 104 void gpu_free(NbnxmGpu gmx_unused* nb) GPU_FUNC_TERM;
 105
 106 /** Returns the GPU timings structure or NULL if GPU is not used or timing is off. */
 107 GPU_FUNC_QUALIFIER
 108 struct gmx_wallclock_gpu_nbnxn_t* gpu_get_timings(NbnxmGpu gmx_unused* nb)
 109         GPU_FUNC_TERM_WITH_RETURN(nullptr);
 110
 111 /** Resets nonbonded GPU timings. */
 112 GPU_FUNC_QUALIFIER
 113 void gpu_reset_timings(struct nonbonded_verlet_t gmx_unused* nbv) GPU_FUNC_TERM;
 114
 115 /** Calculates the minimum size of proximity lists to improve SM load balance
 116  *  with GPU non-bonded kernels. */
 117 GPU_FUNC_QUALIFIER
 118 int gpu_min_ci_balanced(NbnxmGpu gmx_unused* nb) GPU_FUNC_TERM_WITH_RETURN(-1);
 119
 120 /** Returns if analytical Ewald GPU kernels are used. */
 121 GPU_FUNC_QUALIFIER
 122 gmx_bool gpu_is_kernel_ewald_analytical(const NbnxmGpu gmx_unused* nb) GPU_FUNC_TERM_WITH_RETURN(FALSE);
 123
 124 /** Returns an opaque pointer to the GPU command stream
 125  *  Note: CUDA only.
 126  */
 127 CUDA_FUNC_QUALIFIER
 128 const DeviceStream* gpu_get_command_stream(NbnxmGpu gmx_unused* nb, gmx::InteractionLocality gmx_unused iloc)
 129         CUDA_FUNC_TERM_WITH_RETURN(nullptr);
 130
 131 /** Returns an opaque pointer to the GPU coordinate+charge array
 132  *  Note: CUDA only.
 133  */
 134 CUDA_FUNC_QUALIFIER
 135 void* gpu_get_xq(NbnxmGpu gmx_unused* nb) CUDA_FUNC_TERM_WITH_RETURN(nullptr);
 136
 137 /** Returns an opaque pointer to the GPU force array
 138  *  Note: CUDA only.
 139  */
 140 CUDA_FUNC_QUALIFIER
 141 DeviceBuffer<gmx::RVec> gpu_get_f(NbnxmGpu gmx_unused* nb)
 142         CUDA_FUNC_TERM_WITH_RETURN(DeviceBuffer<gmx::RVec>{});
 143
 144 /** Returns an opaque pointer to the GPU shift force array
 145  *  Note: CUDA only.
 146  */
 147 CUDA_FUNC_QUALIFIER
 148 DeviceBuffer<gmx::RVec> gpu_get_fshift(NbnxmGpu gmx_unused* nb)
 149         CUDA_FUNC_TERM_WITH_RETURN(DeviceBuffer<gmx::RVec>{});
 150
 151 } // namespace Nbnxm
 152
 153 #endif