src/gromacs/mdlib/nbnxn_cuda/nbnxn_cuda_data_mgmt.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014, 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
  36 #ifndef NBNXN_CUDA_DATA_MGMT_H
  37 #define NBNXN_CUDA_DATA_MGMT_H
  38
  39 #include "types/simple.h"
  40 #include "types/interaction_const.h"
  41 #include "types/nbnxn_cuda_types_ext.h"
  42 #include "types/hw_info.h"
  43
  44 #ifdef GMX_GPU
  45 #define FUNC_TERM ;
  46 #define FUNC_QUALIFIER
  47 #else
  48 #define FUNC_TERM {}
  49 #define FUNC_QUALIFIER static
  50 #endif
  51
  52 #ifdef __cplusplus
  53 extern "C" {
  54 #endif
  55
  56 struct nonbonded_verlet_group_t;
  57 struct nbnxn_pairlist_t;
  58 struct nbnxn_atomdata_t;
  59
  60 /** Initializes the data structures related to CUDA nonbonded calculations. */
  61 FUNC_QUALIFIER
  62 void nbnxn_cuda_init(FILE gmx_unused                 *fplog,
  63                      nbnxn_cuda_ptr_t gmx_unused     *p_cu_nb,
  64                      const gmx_gpu_info_t gmx_unused *gpu_info,
  65                      const gmx_gpu_opt_t gmx_unused  *gpu_opt,
  66                      int gmx_unused                   my_gpu_index,
  67                      /* true of both local and non-local are don on GPU */
  68                      gmx_bool gmx_unused              bLocalAndNonlocal) FUNC_TERM
  69
  70 /** Initializes simulation constant data. */
  71 FUNC_QUALIFIER
  72 void nbnxn_cuda_init_const(nbnxn_cuda_ptr_t               gmx_unused         cu_nb,
  73                            const interaction_const_t      gmx_unused        *ic,
  74                            const struct nonbonded_verlet_group_t gmx_unused *nbv_group) FUNC_TERM
  75
  76 /** Initializes pair-list data for GPU, called at every pair search step. */
  77 FUNC_QUALIFIER
  78 void nbnxn_cuda_init_pairlist(nbnxn_cuda_ptr_t       gmx_unused         cu_nb,
  79                               const struct nbnxn_pairlist_t gmx_unused *h_nblist,
  80                               int                    gmx_unused         iloc) FUNC_TERM
  81
  82 /** Initializes atom-data on the GPU, called at every pair search step. */
  83 FUNC_QUALIFIER
  84 void nbnxn_cuda_init_atomdata(const nbnxn_cuda_ptr_t       gmx_unused   cu_nb,
  85                               const struct nbnxn_atomdata_t gmx_unused *atomdata) FUNC_TERM
  86
  87 /*! \brief Update parameters during PP-PME load balancing. */
  88 FUNC_QUALIFIER
  89 void nbnxn_cuda_pme_loadbal_update_param(const struct nonbonded_verlet_t gmx_unused *nbv,
  90                                          const interaction_const_t gmx_unused       *ic) FUNC_TERM
  91
  92 /** Uploads shift vector to the GPU if the box is dynamic (otherwise just returns). */
  93 FUNC_QUALIFIER
  94 void nbnxn_cuda_upload_shiftvec(nbnxn_cuda_ptr_t       gmx_unused         cu_nb,
  95                                 const struct nbnxn_atomdata_t gmx_unused *nbatom) FUNC_TERM
  96
  97 /** Clears GPU outputs: nonbonded force, shift force and energy. */
  98 FUNC_QUALIFIER
  99 void nbnxn_cuda_clear_outputs(nbnxn_cuda_ptr_t gmx_unused cu_nb,
 100                               int              gmx_unused flags) FUNC_TERM
 101
 102 /** Frees all GPU resources used for the nonbonded calculations. */
 103 FUNC_QUALIFIER
 104 void nbnxn_cuda_free(nbnxn_cuda_ptr_t gmx_unused  cu_nb) FUNC_TERM
 105
 106 /** Returns the GPU timings structure or NULL if GPU is not used or timing is off. */
 107 FUNC_QUALIFIER
 108 wallclock_gpu_t * nbnxn_cuda_get_timings(nbnxn_cuda_ptr_t gmx_unused cu_nb)
 109 #ifdef GMX_GPU
 110 ;
 111 #else
 112 {
 113     return NULL;
 114 }
 115 #endif
 116
 117 /** Resets nonbonded GPU timings. */
 118 FUNC_QUALIFIER
 119 void nbnxn_cuda_reset_timings(struct nonbonded_verlet_t gmx_unused *nbv) FUNC_TERM
 120
 121 /** Calculates the minimum size of proximity lists to improve SM load balance
 122  *  with CUDA non-bonded kernels. */
 123 FUNC_QUALIFIER
 124 int nbnxn_cuda_min_ci_balanced(nbnxn_cuda_ptr_t gmx_unused cu_nb)
 125 #ifdef GMX_GPU
 126 ;
 127 #else
 128 {
 129     return -1;
 130 }
 131 #endif
 132
 133 /** Returns if analytical Ewald CUDA kernels are used. */
 134 FUNC_QUALIFIER
 135 gmx_bool nbnxn_cuda_is_kernel_ewald_analytical(const nbnxn_cuda_ptr_t gmx_unused cu_nb)
 136 #ifdef GMX_GPU
 137 ;
 138 #else
 139 {
 140     return FALSE;
 141 }
 142 #endif
 143
 144 #ifdef __cplusplus
 145 }
 146 #endif
 147
 148 #undef FUNC_TERM
 149 #undef FUNC_QUALIFIER
 150
 151 #endif /* NBNXN_CUDA_DATA_MGMT_H */