include/nbnxn_cuda_data_mgmt.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2012, The GROMACS development team,
   6  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012,2013, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38
  39 #ifndef NBNXN_CUDA_DATA_MGMT_H
  40 #define NBNXN_CUDA_DATA_MGMT_H
  41
  42 #include "types/simple.h"
  43 #include "types/interaction_const.h"
  44 #include "types/nbnxn_cuda_types_ext.h"
  45 #include "types/hw_info.h"
  46
  47 #ifdef GMX_GPU
  48 #define FUNC_TERM ;
  49 #define FUNC_QUALIFIER
  50 #else
  51 #define FUNC_TERM {}
  52 #define FUNC_QUALIFIER static
  53 #endif
  54
  55 #ifdef __cplusplus
  56 extern "C" {
  57 #endif
  58
  59 /*! Initializes the data structures related to CUDA nonbonded calculations. */
  60 FUNC_QUALIFIER
  61 void nbnxn_cuda_init(FILE *fplog,
  62                      nbnxn_cuda_ptr_t *p_cu_nb,
  63                      gmx_gpu_info_t *gpu_info, int my_gpu_index,
  64                      /* true of both local and non-local are don on GPU */
  65                      gmx_bool bLocalAndNonlocal) FUNC_TERM
  66
  67 /*! Initializes simulation constant data. */
  68 FUNC_QUALIFIER
  69 void nbnxn_cuda_init_const(nbnxn_cuda_ptr_t                cu_nb,
  70                            const interaction_const_t      *ic,
  71                            const nonbonded_verlet_group_t *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        cu_nb,
  76                               const nbnxn_pairlist_t *h_nblist,
  77                               int                     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        cu_nb,
  82                               const nbnxn_atomdata_t *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           cu_nb,
  87                                          const interaction_const_t *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        cu_nb,
  92                                 const nbnxn_atomdata_t *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 cu_nb,
  97                               int              flags) FUNC_TERM
  98
  99 /*! Frees all GPU resources used for the nonbonded calculations. */
 100 FUNC_QUALIFIER
 101 void nbnxn_cuda_free(FILE            *fplog,
 102                      nbnxn_cuda_ptr_t cu_nb) FUNC_TERM
 103
 104 /*! Returns the GPU timings structure or NULL if GPU is not used or timing is off. */
 105 FUNC_QUALIFIER
 106 wallclock_gpu_t * nbnxn_cuda_get_timings(nbnxn_cuda_ptr_t cu_nb)
 107 #ifdef GMX_GPU
 108 ;
 109 #else
 110 {
 111     return NULL;
 112 }
 113 #endif
 114
 115 /*! Resets nonbonded GPU timings. */
 116 FUNC_QUALIFIER
 117 void nbnxn_cuda_reset_timings(nbnxn_cuda_ptr_t cu_nb) FUNC_TERM
 118
 119 /*! Calculates the minimum size of proximity lists to improve SM load balance
 120     with CUDA non-bonded kernels. */
 121 FUNC_QUALIFIER
 122 int nbnxn_cuda_min_ci_balanced(nbnxn_cuda_ptr_t cu_nb)
 123 #ifdef GMX_GPU
 124 ;
 125 #else
 126 {
 127     return -1;
 128 }
 129 #endif
 130
 131 #ifdef __cplusplus
 132 }
 133 #endif
 134
 135 #undef FUNC_TERM
 136 #undef FUNC_QUALIFIER
 137
 138 #endif /* NBNXN_CUDA_DATA_MGMT_H */