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