src/gromacs/nbnxm/nbnxm_gpu_data_mgmt.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2016 by the GROMACS development team.
   5  * Copyright (c) 2017,2018,2019,2020, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \internal \file
  37  *  \brief Define common implementation of nbnxm_gpu_data_mgmt.h
  38  *
  39  *  \author Anca Hamuraru <anca@streamcomputing.eu>
  40  *  \author Dimitrios Karkoulis <dimitris.karkoulis@gmail.com>
  41  *  \author Teemu Virolainen <teemu@streamcomputing.eu>
  42  *  \author Szilárd Páll <pall.szilard@gmail.com>
  43  *  \author Artem Zhmurov <zhmurov@gmail.com>
  44  *
  45  *  \ingroup module_nbnxm
  46  */
  47 #include "gmxpre.h"
  48
  49 #include "config.h"
  50
  51 #if GMX_GPU_CUDA
  52 #    include "cuda/nbnxm_cuda_types.h"
  53 #endif
  54
  55 #if GMX_GPU_OPENCL
  56 #    include "opencl/nbnxm_ocl_types.h"
  57 #endif
  58
  59 #include "nbnxm_gpu_data_mgmt.h"
  60
  61 #include "gromacs/mdtypes/interaction_const.h"
  62 #include "gromacs/nbnxm/gpu_data_mgmt.h"
  63 #include "gromacs/timing/gpu_timing.h"
  64 #include "gromacs/utility/cstringutil.h"
  65
  66 #include "nbnxm_gpu.h"
  67 #include "pairlistsets.h"
  68
  69 namespace Nbnxm
  70 {
  71
  72 void init_ewald_coulomb_force_table(const EwaldCorrectionTables& tables,
  73                                     NBParamGpu*                  nbp,
  74                                     const DeviceContext&         deviceContext)
  75 {
  76     if (nbp->coulomb_tab)
  77     {
  78         destroyParamLookupTable(&nbp->coulomb_tab, nbp->coulomb_tab_texobj);
  79     }
  80
  81     nbp->coulomb_tab_scale = tables.scale;
  82     initParamLookupTable(&nbp->coulomb_tab, &nbp->coulomb_tab_texobj, tables.tableF.data(),
  83                          tables.tableF.size(), deviceContext);
  84 }
  85
  86 void inline printEnvironmentVariableDeprecationMessage(bool               isEnvironmentVariableSet,
  87                                                        const std::string& environmentVariableSuffix)
  88 {
  89     if (isEnvironmentVariableSet)
  90     {
  91         fprintf(stderr,
  92                 "Environment variables GMX_CUDA_%s and GMX_OCL_%s are deprecated and will be\n"
  93                 "removed in release 2022, please use GMX_GPU_%s instead.",
  94                 environmentVariableSuffix.c_str(), environmentVariableSuffix.c_str(),
  95                 environmentVariableSuffix.c_str());
  96     }
  97 }
  98
  99 enum ElecType nbnxn_gpu_pick_ewald_kernel_type(const interaction_const_t& ic)
 100 {
 101     bool bTwinCut = (ic.rcoulomb != ic.rvdw);
 102
 103     /* Benchmarking/development environment variables to force the use of
 104        analytical or tabulated Ewald kernel. */
 105
 106     // Remove these when old environment variables are deprecated
 107     const bool forceAnalyticalEwaldLegacy = (getenv("GMX_CUDA_NB_ANA_EWALD") != nullptr)
 108                                             || (getenv("GMX_OCL_NB_ANA_EWALD") != nullptr);
 109     const bool forceTabulatedEwaldLegacy = (getenv("GMX_CUDA_NB_TAB_EWALD") != nullptr)
 110                                            || (getenv("GMX_OCL_NB_TAB_EWALD") != nullptr);
 111     const bool forceTwinCutoffEwaldLegacy = (getenv("GMX_CUDA_NB_EWALD_TWINCUT") != nullptr)
 112                                             || (getenv("GMX_OCL_NB_EWALD_TWINCUT") != nullptr);
 113
 114     printEnvironmentVariableDeprecationMessage(forceAnalyticalEwaldLegacy, "NB_ANA_EWALD");
 115     printEnvironmentVariableDeprecationMessage(forceTabulatedEwaldLegacy, "NB_TAB_EWALD");
 116     printEnvironmentVariableDeprecationMessage(forceTwinCutoffEwaldLegacy, "NB_EWALD_TWINCUT");
 117
 118     const bool forceAnalyticalEwald =
 119             (getenv("GMX_GPU_NB_ANA_EWALD") != nullptr) || forceAnalyticalEwaldLegacy;
 120     const bool forceTabulatedEwald =
 121             (getenv("GMX_GPU_NB_TAB_EWALD") != nullptr) || forceTabulatedEwaldLegacy;
 122
 123     if (forceAnalyticalEwald && forceTabulatedEwald)
 124     {
 125         gmx_incons(
 126                 "Both analytical and tabulated Ewald GPU non-bonded kernels "
 127                 "requested through environment variables.");
 128     }
 129
 130     /* By default, use analytical Ewald
 131      * TODO: tabulated does not work in OpenCL, it needs fixing, see init_nbparam() in nbnxn_ocl_data_mgmt.cpp
 132      *
 133      */
 134     bool bUseAnalyticalEwald = true;
 135     if (forceAnalyticalEwald)
 136     {
 137         if (debug)
 138         {
 139             fprintf(debug, "Using analytical Ewald GPU kernels\n");
 140         }
 141     }
 142     else if (forceTabulatedEwald)
 143     {
 144         bUseAnalyticalEwald = false;
 145
 146         if (debug)
 147         {
 148             fprintf(debug, "Using tabulated Ewald GPU kernels\n");
 149         }
 150     }
 151
 152     /* Use twin cut-off kernels if requested by bTwinCut or the env. var.
 153        forces it (use it for debugging/benchmarking only). */
 154     if (!bTwinCut && ((getenv("GMX_GPU_NB_EWALD_TWINCUT") == nullptr) || forceTwinCutoffEwaldLegacy))
 155     {
 156         return bUseAnalyticalEwald ? ElecType::EwaldAna : ElecType::EwaldTab;
 157     }
 158     else
 159     {
 160         return bUseAnalyticalEwald ? ElecType::EwaldAnaTwin : ElecType::EwaldTabTwin;
 161     }
 162 }
 163
 164 void set_cutoff_parameters(NBParamGpu* nbp, const interaction_const_t* ic, const PairlistParams& listParams)
 165 {
 166     nbp->ewald_beta        = ic->ewaldcoeff_q;
 167     nbp->sh_ewald          = ic->sh_ewald;
 168     nbp->epsfac            = ic->epsfac;
 169     nbp->two_k_rf          = 2.0 * ic->k_rf;
 170     nbp->c_rf              = ic->c_rf;
 171     nbp->rvdw_sq           = ic->rvdw * ic->rvdw;
 172     nbp->rcoulomb_sq       = ic->rcoulomb * ic->rcoulomb;
 173     nbp->rlistOuter_sq     = listParams.rlistOuter * listParams.rlistOuter;
 174     nbp->rlistInner_sq     = listParams.rlistInner * listParams.rlistInner;
 175     nbp->useDynamicPruning = listParams.useDynamicPruning;
 176
 177     nbp->sh_lj_ewald   = ic->sh_lj_ewald;
 178     nbp->ewaldcoeff_lj = ic->ewaldcoeff_lj;
 179
 180     nbp->rvdw_switch      = ic->rvdw_switch;
 181     nbp->dispersion_shift = ic->dispersion_shift;
 182     nbp->repulsion_shift  = ic->repulsion_shift;
 183     nbp->vdw_switch       = ic->vdw_switch;
 184 }
 185
 186 void gpu_pme_loadbal_update_param(const nonbonded_verlet_t* nbv, const interaction_const_t* ic)
 187 {
 188     if (!nbv || !nbv->useGpu())
 189     {
 190         return;
 191     }
 192     NbnxmGpu*   nb  = nbv->gpu_nbv;
 193     NBParamGpu* nbp = nb->nbparam;
 194
 195     set_cutoff_parameters(nbp, ic, nbv->pairlistSets().params());
 196
 197     nbp->elecType = nbnxn_gpu_pick_ewald_kernel_type(*ic);
 198
 199     GMX_RELEASE_ASSERT(ic->coulombEwaldTables, "Need valid Coulomb Ewald correction tables");
 200     init_ewald_coulomb_force_table(*ic->coulombEwaldTables, nbp, *nb->deviceContext_);
 201 }
 202
 203 void init_plist(gpu_plist* pl)
 204 {
 205     /* initialize to nullptr pointers to data that is not allocated here and will
 206        need reallocation in nbnxn_gpu_init_pairlist */
 207     pl->sci   = nullptr;
 208     pl->cj4   = nullptr;
 209     pl->imask = nullptr;
 210     pl->excl  = nullptr;
 211
 212     /* size -1 indicates that the respective array hasn't been initialized yet */
 213     pl->na_c          = -1;
 214     pl->nsci          = -1;
 215     pl->sci_nalloc    = -1;
 216     pl->ncj4          = -1;
 217     pl->cj4_nalloc    = -1;
 218     pl->nimask        = -1;
 219     pl->imask_nalloc  = -1;
 220     pl->nexcl         = -1;
 221     pl->excl_nalloc   = -1;
 222     pl->haveFreshList = false;
 223 }
 224
 225 void init_timings(gmx_wallclock_gpu_nbnxn_t* t)
 226 {
 227     int i, j;
 228
 229     t->nb_h2d_t = 0.0;
 230     t->nb_d2h_t = 0.0;
 231     t->nb_c     = 0;
 232     t->pl_h2d_t = 0.0;
 233     t->pl_h2d_c = 0;
 234     for (i = 0; i < 2; i++)
 235     {
 236         for (j = 0; j < 2; j++)
 237         {
 238             t->ktime[i][j].t = 0.0;
 239             t->ktime[i][j].c = 0;
 240         }
 241     }
 242     t->pruneTime.c        = 0;
 243     t->pruneTime.t        = 0.0;
 244     t->dynamicPruneTime.c = 0;
 245     t->dynamicPruneTime.t = 0.0;
 246 }
 247
 248 //! This function is documented in the header file
 249 void gpu_init_pairlist(NbnxmGpu* nb, const NbnxnPairlistGpu* h_plist, const InteractionLocality iloc)
 250 {
 251     char sbuf[STRLEN];
 252     // Timing accumulation should happen only if there was work to do
 253     // because getLastRangeTime() gets skipped with empty lists later
 254     // which leads to the counter not being reset.
 255     bool                bDoTime      = (nb->bDoTime && !h_plist->sci.empty());
 256     const DeviceStream& deviceStream = *nb->deviceStreams[iloc];
 257     gpu_plist*          d_plist      = nb->plist[iloc];
 258
 259     if (d_plist->na_c < 0)
 260     {
 261         d_plist->na_c = h_plist->na_ci;
 262     }
 263     else
 264     {
 265         if (d_plist->na_c != h_plist->na_ci)
 266         {
 267             sprintf(sbuf, "In init_plist: the #atoms per cell has changed (from %d to %d)",
 268                     d_plist->na_c, h_plist->na_ci);
 269             gmx_incons(sbuf);
 270         }
 271     }
 272
 273     gpu_timers_t::Interaction& iTimers = nb->timers->interaction[iloc];
 274
 275     if (bDoTime)
 276     {
 277         iTimers.pl_h2d.openTimingRegion(deviceStream);
 278         iTimers.didPairlistH2D = true;
 279     }
 280
 281     // TODO most of this function is same in CUDA and OpenCL, move into the header
 282     const DeviceContext& deviceContext = *nb->deviceContext_;
 283
 284     reallocateDeviceBuffer(&d_plist->sci, h_plist->sci.size(), &d_plist->nsci, &d_plist->sci_nalloc,
 285                            deviceContext);
 286     copyToDeviceBuffer(&d_plist->sci, h_plist->sci.data(), 0, h_plist->sci.size(), deviceStream,
 287                        GpuApiCallBehavior::Async, bDoTime ? iTimers.pl_h2d.fetchNextEvent() : nullptr);
 288
 289     reallocateDeviceBuffer(&d_plist->cj4, h_plist->cj4.size(), &d_plist->ncj4, &d_plist->cj4_nalloc,
 290                            deviceContext);
 291     copyToDeviceBuffer(&d_plist->cj4, h_plist->cj4.data(), 0, h_plist->cj4.size(), deviceStream,
 292                        GpuApiCallBehavior::Async, bDoTime ? iTimers.pl_h2d.fetchNextEvent() : nullptr);
 293
 294     reallocateDeviceBuffer(&d_plist->imask, h_plist->cj4.size() * c_nbnxnGpuClusterpairSplit,
 295                            &d_plist->nimask, &d_plist->imask_nalloc, deviceContext);
 296
 297     reallocateDeviceBuffer(&d_plist->excl, h_plist->excl.size(), &d_plist->nexcl,
 298                            &d_plist->excl_nalloc, deviceContext);
 299     copyToDeviceBuffer(&d_plist->excl, h_plist->excl.data(), 0, h_plist->excl.size(), deviceStream,
 300                        GpuApiCallBehavior::Async, bDoTime ? iTimers.pl_h2d.fetchNextEvent() : nullptr);
 301
 302     if (bDoTime)
 303     {
 304         iTimers.pl_h2d.closeTimingRegion(deviceStream);
 305     }
 306
 307     /* need to prune the pair list during the next step */
 308     d_plist->haveFreshList = true;
 309 }
 310
 311 //! This function is documented in the header file
 312 gmx_wallclock_gpu_nbnxn_t* gpu_get_timings(NbnxmGpu* nb)
 313 {
 314     return (nb != nullptr && nb->bDoTime) ? nb->timings : nullptr;
 315 }
 316
 317 //! This function is documented in the header file
 318 void gpu_reset_timings(nonbonded_verlet_t* nbv)
 319 {
 320     if (nbv->gpu_nbv && nbv->gpu_nbv->bDoTime)
 321     {
 322         init_timings(nbv->gpu_nbv->timings);
 323     }
 324 }
 325
 326 bool gpu_is_kernel_ewald_analytical(const NbnxmGpu* nb)
 327 {
 328     return ((nb->nbparam->elecType == ElecType::EwaldAna)
 329             || (nb->nbparam->elecType == ElecType::EwaldAnaTwin));
 330 }
 331
 332 enum ElecType nbnxmGpuPickElectrostaticsKernelType(const interaction_const_t* ic)
 333 {
 334     if (ic->eeltype == eelCUT)
 335     {
 336         return ElecType::Cut;
 337     }
 338     else if (EEL_RF(ic->eeltype))
 339     {
 340         return ElecType::RF;
 341     }
 342     else if ((EEL_PME(ic->eeltype) || ic->eeltype == eelEWALD))
 343     {
 344         return nbnxn_gpu_pick_ewald_kernel_type(*ic);
 345     }
 346     else
 347     {
 348         /* Shouldn't happen, as this is checked when choosing Verlet-scheme */
 349         GMX_THROW(gmx::InconsistentInputError(
 350                 gmx::formatString("The requested electrostatics type %s (%d) is not implemented in "
 351                                   "the GPU accelerated kernels!",
 352                                   EELTYPE(ic->eeltype), ic->eeltype)));
 353     }
 354 }
 355
 356
 357 enum VdwType nbnxmGpuPickVdwKernelType(const interaction_const_t* ic, int combRule)
 358 {
 359     if (ic->vdwtype == evdwCUT)
 360     {
 361         switch (ic->vdw_modifier)
 362         {
 363             case eintmodNONE:
 364             case eintmodPOTSHIFT:
 365                 switch (combRule)
 366                 {
 367                     case ljcrNONE: return VdwType::Cut;
 368                     case ljcrGEOM: return VdwType::CutCombGeom;
 369                     case ljcrLB: return VdwType::CutCombLB;
 370                     default:
 371                         GMX_THROW(gmx::InconsistentInputError(gmx::formatString(
 372                                 "The requested LJ combination rule %s (%d) is not implemented in "
 373                                 "the GPU accelerated kernels!",
 374                                 enum_name(combRule, ljcrNR, c_ljcrNames), combRule)));
 375                 }
 376             case eintmodFORCESWITCH: return VdwType::FSwitch;
 377             case eintmodPOTSWITCH: return VdwType::PSwitch;
 378             default:
 379                 GMX_THROW(gmx::InconsistentInputError(
 380                         gmx::formatString("The requested VdW interaction modifier %s (%d) is not "
 381                                           "implemented in the GPU accelerated kernels!",
 382                                           INTMODIFIER(ic->vdw_modifier), ic->vdw_modifier)));
 383         }
 384     }
 385     else if (ic->vdwtype == evdwPME)
 386     {
 387         if (ic->ljpme_comb_rule == ljcrGEOM)
 388         {
 389             assert(combRule == ljcrGEOM);
 390             return VdwType::EwaldGeom;
 391         }
 392         else
 393         {
 394             assert(combRule == ljcrLB);
 395             return VdwType::EwaldLB;
 396         }
 397     }
 398     else
 399     {
 400         GMX_THROW(gmx::InconsistentInputError(gmx::formatString(
 401                 "The requested VdW type %s (%d) is not implemented in the GPU accelerated kernels!",
 402                 EVDWTYPE(ic->vdwtype), ic->vdwtype)));
 403     }
 404 }
 405
 406 } // namespace Nbnxm