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