src/gromacs/nbnxm/opencl/nbnxm_ocl_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 OpenCL 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  *  \ingroup module_nbnxm
  44  */
  45 #include "gmxpre.h"
  46
  47 #include <assert.h>
  48 #include <stdarg.h>
  49 #include <stdio.h>
  50 #include <stdlib.h>
  51 #include <string.h>
  52
  53 #include <cmath>
  54
  55 #include "gromacs/gpu_utils/device_stream_manager.h"
  56 #include "gromacs/gpu_utils/oclutils.h"
  57 #include "gromacs/hardware/device_information.h"
  58 #include "gromacs/hardware/device_management.h"
  59 #include "gromacs/math/vectypes.h"
  60 #include "gromacs/mdlib/force_flags.h"
  61 #include "gromacs/mdtypes/interaction_const.h"
  62 #include "gromacs/mdtypes/md_enums.h"
  63 #include "gromacs/nbnxm/atomdata.h"
  64 #include "gromacs/nbnxm/gpu_data_mgmt.h"
  65 #include "gromacs/nbnxm/gpu_jit_support.h"
  66 #include "gromacs/nbnxm/nbnxm.h"
  67 #include "gromacs/nbnxm/nbnxm_gpu.h"
  68 #include "gromacs/nbnxm/nbnxm_gpu_data_mgmt.h"
  69 #include "gromacs/nbnxm/pairlistsets.h"
  70 #include "gromacs/pbcutil/ishift.h"
  71 #include "gromacs/timing/gpu_timing.h"
  72 #include "gromacs/utility/cstringutil.h"
  73 #include "gromacs/utility/fatalerror.h"
  74 #include "gromacs/utility/gmxassert.h"
  75 #include "gromacs/utility/real.h"
  76 #include "gromacs/utility/smalloc.h"
  77
  78 #include "nbnxm_ocl_types.h"
  79
  80 namespace Nbnxm
  81 {
  82
  83 /*! \brief Copies of values from cl_driver_diagnostics_intel.h,
  84  * which isn't guaranteed to be available. */
  85 /**@{*/
  86 #define CL_CONTEXT_SHOW_DIAGNOSTICS_INTEL 0x4106
  87 #define CL_CONTEXT_DIAGNOSTICS_LEVEL_GOOD_INTEL 0x1
  88 #define CL_CONTEXT_DIAGNOSTICS_LEVEL_BAD_INTEL 0x2
  89 #define CL_CONTEXT_DIAGNOSTICS_LEVEL_NEUTRAL_INTEL 0x4
  90 /**@}*/
  91
  92 /*! \brief This parameter should be determined heuristically from the
  93  * kernel execution times
  94  *
  95  * This value is best for small systems on a single AMD Radeon R9 290X
  96  * (and about 5% faster than 40, which is the default for CUDA
  97  * devices). Larger simulation systems were quite insensitive to the
  98  * value of this parameter.
  99  */
 100 static unsigned int gpu_min_ci_balanced_factor = 50;
 101
 102
 103 /*! \brief Initializes the atomdata structure first time, it only gets filled at
 104     pair-search.
 105  */
 106 static void init_atomdata_first(cl_atomdata_t* ad, int ntypes, const DeviceContext& deviceContext)
 107 {
 108     ad->ntypes = ntypes;
 109
 110     allocateDeviceBuffer(&ad->shift_vec, SHIFTS * DIM, deviceContext);
 111     ad->bShiftVecUploaded = CL_FALSE;
 112
 113     allocateDeviceBuffer(&ad->fshift, SHIFTS * DIM, deviceContext);
 114     allocateDeviceBuffer(&ad->e_lj, 1, deviceContext);
 115     allocateDeviceBuffer(&ad->e_el, 1, deviceContext);
 116
 117     /* initialize to nullptr pointers to data that is not allocated here and will
 118        need reallocation in nbnxn_gpu_init_atomdata */
 119     ad->xq = nullptr;
 120     ad->f  = nullptr;
 121
 122     /* size -1 indicates that the respective array hasn't been initialized yet */
 123     ad->natoms = -1;
 124     ad->nalloc = -1;
 125 }
 126
 127 /*! \brief Returns the kinds of electrostatics and Vdw OpenCL
 128  *  kernels that will be used.
 129  *
 130  * Respectively, these values are from enum eelOcl and enum
 131  * evdwOcl. */
 132 static void map_interaction_types_to_gpu_kernel_flavors(const interaction_const_t* ic,
 133                                                         int                        combRule,
 134                                                         int*                       gpu_eeltype,
 135                                                         int*                       gpu_vdwtype)
 136 {
 137     if (ic->vdwtype == evdwCUT)
 138     {
 139         switch (ic->vdw_modifier)
 140         {
 141             case eintmodNONE:
 142             case eintmodPOTSHIFT:
 143                 switch (combRule)
 144                 {
 145                     case ljcrNONE: *gpu_vdwtype = evdwTypeCUT; break;
 146                     case ljcrGEOM: *gpu_vdwtype = evdwTypeCUTCOMBGEOM; break;
 147                     case ljcrLB: *gpu_vdwtype = evdwTypeCUTCOMBLB; break;
 148                     default:
 149                         gmx_incons(
 150                                 "The requested LJ combination rule is not implemented in the "
 151                                 "OpenCL GPU accelerated kernels!");
 152                 }
 153                 break;
 154             case eintmodFORCESWITCH: *gpu_vdwtype = evdwTypeFSWITCH; break;
 155             case eintmodPOTSWITCH: *gpu_vdwtype = evdwTypePSWITCH; break;
 156             default:
 157                 gmx_incons(
 158                         "The requested VdW interaction modifier is not implemented in the GPU "
 159                         "accelerated kernels!");
 160         }
 161     }
 162     else if (ic->vdwtype == evdwPME)
 163     {
 164         if (ic->ljpme_comb_rule == ljcrGEOM)
 165         {
 166             *gpu_vdwtype = evdwTypeEWALDGEOM;
 167         }
 168         else
 169         {
 170             *gpu_vdwtype = evdwTypeEWALDLB;
 171         }
 172     }
 173     else
 174     {
 175         gmx_incons("The requested VdW type is not implemented in the GPU accelerated kernels!");
 176     }
 177
 178     if (ic->eeltype == eelCUT)
 179     {
 180         *gpu_eeltype = eelTypeCUT;
 181     }
 182     else if (EEL_RF(ic->eeltype))
 183     {
 184         *gpu_eeltype = eelTypeRF;
 185     }
 186     else if ((EEL_PME(ic->eeltype) || ic->eeltype == eelEWALD))
 187     {
 188         *gpu_eeltype = nbnxn_gpu_pick_ewald_kernel_type(*ic);
 189     }
 190     else
 191     {
 192         /* Shouldn't happen, as this is checked when choosing Verlet-scheme */
 193         gmx_incons(
 194                 "The requested electrostatics type is not implemented in the GPU accelerated "
 195                 "kernels!");
 196     }
 197 }
 198
 199 /*! \brief Initializes the nonbonded parameter data structure.
 200  */
 201 static void init_nbparam(NBParamGpu*                     nbp,
 202                          const interaction_const_t*      ic,
 203                          const PairlistParams&           listParams,
 204                          const nbnxn_atomdata_t::Params& nbatParams,
 205                          const DeviceContext&            deviceContext)
 206 {
 207     set_cutoff_parameters(nbp, ic, listParams);
 208
 209     map_interaction_types_to_gpu_kernel_flavors(ic, nbatParams.comb_rule, &(nbp->eeltype), &(nbp->vdwtype));
 210
 211     if (ic->vdwtype == evdwPME)
 212     {
 213         if (ic->ljpme_comb_rule == ljcrGEOM)
 214         {
 215             GMX_ASSERT(nbatParams.comb_rule == ljcrGEOM, "Combination rule mismatch!");
 216         }
 217         else
 218         {
 219             GMX_ASSERT(nbatParams.comb_rule == ljcrLB, "Combination rule mismatch!");
 220         }
 221     }
 222     /* generate table for PME */
 223     nbp->coulomb_tab = nullptr;
 224     if (nbp->eeltype == eelTypeEWALD_TAB || nbp->eeltype == eelTypeEWALD_TAB_TWIN)
 225     {
 226         GMX_RELEASE_ASSERT(ic->coulombEwaldTables, "Need valid Coulomb Ewald correction tables");
 227         init_ewald_coulomb_force_table(*ic->coulombEwaldTables, nbp, deviceContext);
 228     }
 229     else
 230     {
 231         allocateDeviceBuffer(&nbp->coulomb_tab, 1, deviceContext);
 232     }
 233
 234     const int nnbfp      = 2 * nbatParams.numTypes * nbatParams.numTypes;
 235     const int nnbfp_comb = 2 * nbatParams.numTypes;
 236
 237     {
 238         /* set up LJ parameter lookup table */
 239         DeviceBuffer<real> nbfp;
 240         initParamLookupTable(&nbfp, nullptr, nbatParams.nbfp.data(), nnbfp, deviceContext);
 241         nbp->nbfp = nbfp;
 242
 243         if (ic->vdwtype == evdwPME)
 244         {
 245             DeviceBuffer<float> nbfp_comb;
 246             initParamLookupTable(&nbfp_comb, nullptr, nbatParams.nbfp_comb.data(), nnbfp_comb, deviceContext);
 247             nbp->nbfp_comb = nbfp_comb;
 248         }
 249     }
 250 }
 251
 252 //! This function is documented in the header file
 253 void gpu_pme_loadbal_update_param(const nonbonded_verlet_t* nbv, const interaction_const_t* ic)
 254 {
 255     if (!nbv || !nbv->useGpu())
 256     {
 257         return;
 258     }
 259     NbnxmGpu*   nb  = nbv->gpu_nbv;
 260     NBParamGpu* nbp = nb->nbparam;
 261
 262     set_cutoff_parameters(nbp, ic, nbv->pairlistSets().params());
 263
 264     nbp->eeltype = nbnxn_gpu_pick_ewald_kernel_type(*ic);
 265
 266     GMX_RELEASE_ASSERT(ic->coulombEwaldTables, "Need valid Coulomb Ewald correction tables");
 267     init_ewald_coulomb_force_table(*ic->coulombEwaldTables, nbp, *nb->deviceContext_);
 268 }
 269
 270 /*! \brief Initializes the OpenCL kernel pointers of the nbnxn_ocl_ptr_t input data structure. */
 271 static cl_kernel nbnxn_gpu_create_kernel(NbnxmGpu* nb, const char* kernel_name)
 272 {
 273     cl_kernel kernel;
 274     cl_int    cl_error;
 275
 276     kernel = clCreateKernel(nb->dev_rundata->program, kernel_name, &cl_error);
 277     if (CL_SUCCESS != cl_error)
 278     {
 279         gmx_fatal(FARGS, "Failed to create kernel '%s' for GPU #%s: OpenCL error %d", kernel_name,
 280                   nb->deviceContext_->deviceInfo().device_name, cl_error);
 281     }
 282
 283     return kernel;
 284 }
 285
 286 /*! \brief Clears nonbonded shift force output array and energy outputs on the GPU.
 287  */
 288 static void nbnxn_ocl_clear_e_fshift(NbnxmGpu* nb)
 289 {
 290
 291     cl_int           cl_error;
 292     cl_atomdata_t*   adat = nb->atdat;
 293     cl_command_queue ls   = nb->deviceStreams[InteractionLocality::Local]->stream();
 294
 295     size_t local_work_size[3]  = { 1, 1, 1 };
 296     size_t global_work_size[3] = { 1, 1, 1 };
 297
 298     cl_int shifts = SHIFTS * 3;
 299
 300     cl_int arg_no;
 301
 302     cl_kernel zero_e_fshift = nb->kernel_zero_e_fshift;
 303
 304     local_work_size[0] = 64;
 305     // Round the total number of threads up from the array size
 306     global_work_size[0] = ((shifts + local_work_size[0] - 1) / local_work_size[0]) * local_work_size[0];
 307
 308     arg_no   = 0;
 309     cl_error = clSetKernelArg(zero_e_fshift, arg_no++, sizeof(cl_mem), &(adat->fshift));
 310     cl_error |= clSetKernelArg(zero_e_fshift, arg_no++, sizeof(cl_mem), &(adat->e_lj));
 311     cl_error |= clSetKernelArg(zero_e_fshift, arg_no++, sizeof(cl_mem), &(adat->e_el));
 312     cl_error |= clSetKernelArg(zero_e_fshift, arg_no++, sizeof(cl_uint), &shifts);
 313     GMX_ASSERT(cl_error == CL_SUCCESS, ocl_get_error_string(cl_error).c_str());
 314
 315     cl_error = clEnqueueNDRangeKernel(ls, zero_e_fshift, 3, nullptr, global_work_size,
 316                                       local_work_size, 0, nullptr, nullptr);
 317     GMX_ASSERT(cl_error == CL_SUCCESS, ocl_get_error_string(cl_error).c_str());
 318 }
 319
 320 /*! \brief Initializes the OpenCL kernel pointers of the nbnxn_ocl_ptr_t input data structure. */
 321 static void nbnxn_gpu_init_kernels(NbnxmGpu* nb)
 322 {
 323     /* Init to 0 main kernel arrays */
 324     /* They will be later on initialized in select_nbnxn_kernel */
 325     // TODO: consider always creating all variants of the kernels here so that there is no
 326     // need for late call to clCreateKernel -- if that gives any advantage?
 327     memset(nb->kernel_ener_noprune_ptr, 0, sizeof(nb->kernel_ener_noprune_ptr));
 328     memset(nb->kernel_ener_prune_ptr, 0, sizeof(nb->kernel_ener_prune_ptr));
 329     memset(nb->kernel_noener_noprune_ptr, 0, sizeof(nb->kernel_noener_noprune_ptr));
 330     memset(nb->kernel_noener_prune_ptr, 0, sizeof(nb->kernel_noener_prune_ptr));
 331
 332     /* Init pruning kernels
 333      *
 334      * TODO: we could avoid creating kernels if dynamic pruning is turned off,
 335      * but ATM that depends on force flags not passed into the initialization.
 336      */
 337     nb->kernel_pruneonly[epruneFirst] = nbnxn_gpu_create_kernel(nb, "nbnxn_kernel_prune_opencl");
 338     nb->kernel_pruneonly[epruneRolling] =
 339             nbnxn_gpu_create_kernel(nb, "nbnxn_kernel_prune_rolling_opencl");
 340
 341     /* Init auxiliary kernels */
 342     nb->kernel_zero_e_fshift = nbnxn_gpu_create_kernel(nb, "zero_e_fshift");
 343 }
 344
 345 /*! \brief Initializes simulation constant data.
 346  *
 347  *  Initializes members of the atomdata and nbparam structs and
 348  *  clears e/fshift output buffers.
 349  */
 350 static void nbnxn_ocl_init_const(cl_atomdata_t*                  atomData,
 351                                  NBParamGpu*                     nbParams,
 352                                  const interaction_const_t*      ic,
 353                                  const PairlistParams&           listParams,
 354                                  const nbnxn_atomdata_t::Params& nbatParams,
 355                                  const DeviceContext&            deviceContext)
 356 {
 357     init_atomdata_first(atomData, nbatParams.numTypes, deviceContext);
 358     init_nbparam(nbParams, ic, listParams, nbatParams, deviceContext);
 359 }
 360
 361
 362 //! This function is documented in the header file
 363 NbnxmGpu* gpu_init(const gmx::DeviceStreamManager& deviceStreamManager,
 364                    const interaction_const_t*      ic,
 365                    const PairlistParams&           listParams,
 366                    const nbnxn_atomdata_t*         nbat,
 367                    const bool                      bLocalAndNonlocal)
 368 {
 369     GMX_ASSERT(ic, "Need a valid interaction constants object");
 370
 371     auto nb            = new NbnxmGpu();
 372     nb->deviceContext_ = &deviceStreamManager.context();
 373     snew(nb->atdat, 1);
 374     snew(nb->nbparam, 1);
 375     snew(nb->plist[InteractionLocality::Local], 1);
 376     if (bLocalAndNonlocal)
 377     {
 378         snew(nb->plist[InteractionLocality::NonLocal], 1);
 379     }
 380
 381     nb->bUseTwoStreams = bLocalAndNonlocal;
 382
 383     nb->timers = new cl_timers_t();
 384     snew(nb->timings, 1);
 385
 386     /* set device info, just point it to the right GPU among the detected ones */
 387     nb->dev_rundata = new gmx_device_runtime_data_t();
 388
 389     /* init nbst */
 390     pmalloc(reinterpret_cast<void**>(&nb->nbst.e_lj), sizeof(*nb->nbst.e_lj));
 391     pmalloc(reinterpret_cast<void**>(&nb->nbst.e_el), sizeof(*nb->nbst.e_el));
 392     pmalloc(reinterpret_cast<void**>(&nb->nbst.fshift), SHIFTS * sizeof(*nb->nbst.fshift));
 393
 394     init_plist(nb->plist[InteractionLocality::Local]);
 395
 396     /* OpenCL timing disabled if GMX_DISABLE_GPU_TIMING is defined. */
 397     nb->bDoTime = (getenv("GMX_DISABLE_GPU_TIMING") == nullptr);
 398
 399     /* local/non-local GPU streams */
 400     GMX_RELEASE_ASSERT(deviceStreamManager.streamIsValid(gmx::DeviceStreamType::NonBondedLocal),
 401                        "Local non-bonded stream should be initialized to use GPU for non-bonded.");
 402     nb->deviceStreams[InteractionLocality::Local] =
 403             &deviceStreamManager.stream(gmx::DeviceStreamType::NonBondedLocal);
 404
 405     if (nb->bUseTwoStreams)
 406     {
 407         init_plist(nb->plist[InteractionLocality::NonLocal]);
 408
 409         GMX_RELEASE_ASSERT(deviceStreamManager.streamIsValid(gmx::DeviceStreamType::NonBondedNonLocal),
 410                            "Non-local non-bonded stream should be initialized to use GPU for "
 411                            "non-bonded with domain decomposition.");
 412         nb->deviceStreams[InteractionLocality::NonLocal] =
 413                 &deviceStreamManager.stream(gmx::DeviceStreamType::NonBondedNonLocal);
 414     }
 415
 416     if (nb->bDoTime)
 417     {
 418         init_timings(nb->timings);
 419     }
 420
 421     nbnxn_ocl_init_const(nb->atdat, nb->nbparam, ic, listParams, nbat->params(), *nb->deviceContext_);
 422
 423     /* Enable LJ param manual prefetch for AMD or Intel or if we request through env. var.
 424      * TODO: decide about NVIDIA
 425      */
 426     nb->bPrefetchLjParam = (getenv("GMX_OCL_DISABLE_I_PREFETCH") == nullptr)
 427                            && ((nb->deviceContext_->deviceInfo().deviceVendor == DeviceVendor::Amd)
 428                                || (nb->deviceContext_->deviceInfo().deviceVendor == DeviceVendor::Intel)
 429                                || (getenv("GMX_OCL_ENABLE_I_PREFETCH") != nullptr));
 430
 431     /* NOTE: in CUDA we pick L1 cache configuration for the nbnxn kernels here,
 432      * but sadly this is not supported in OpenCL (yet?). Consider adding it if
 433      * it becomes supported.
 434      */
 435     nbnxn_gpu_compile_kernels(nb);
 436     nbnxn_gpu_init_kernels(nb);
 437
 438     /* clear energy and shift force outputs */
 439     nbnxn_ocl_clear_e_fshift(nb);
 440
 441     if (debug)
 442     {
 443         fprintf(debug, "Initialized OpenCL data structures.\n");
 444     }
 445
 446     return nb;
 447 }
 448
 449 /*! \brief Clears the first natoms_clear elements of the GPU nonbonded force output array.
 450  */
 451 static void nbnxn_ocl_clear_f(NbnxmGpu* nb, int natoms_clear)
 452 {
 453     if (natoms_clear == 0)
 454     {
 455         return;
 456     }
 457
 458     cl_atomdata_t*      atomData    = nb->atdat;
 459     const DeviceStream& localStream = *nb->deviceStreams[InteractionLocality::Local];
 460
 461     clearDeviceBufferAsync(&atomData->f, 0, natoms_clear * DIM, localStream);
 462 }
 463
 464 //! This function is documented in the header file
 465 void gpu_clear_outputs(NbnxmGpu* nb, bool computeVirial)
 466 {
 467     nbnxn_ocl_clear_f(nb, nb->atdat->natoms);
 468     /* clear shift force array and energies if the outputs were
 469        used in the current step */
 470     if (computeVirial)
 471     {
 472         nbnxn_ocl_clear_e_fshift(nb);
 473     }
 474
 475     /* kick off buffer clearing kernel to ensure concurrency with constraints/update */
 476     cl_int gmx_unused cl_error;
 477     cl_error = clFlush(nb->deviceStreams[InteractionLocality::Local]->stream());
 478     GMX_ASSERT(cl_error == CL_SUCCESS, ("clFlush failed: " + ocl_get_error_string(cl_error)).c_str());
 479 }
 480
 481 //! This function is documented in the header file
 482 void gpu_init_pairlist(NbnxmGpu* nb, const NbnxnPairlistGpu* h_plist, const InteractionLocality iloc)
 483 {
 484     char sbuf[STRLEN];
 485     // Timing accumulation should happen only if there was work to do
 486     // because getLastRangeTime() gets skipped with empty lists later
 487     // which leads to the counter not being reset.
 488     bool                bDoTime      = (nb->bDoTime && !h_plist->sci.empty());
 489     const DeviceStream& deviceStream = *nb->deviceStreams[iloc];
 490     gpu_plist*          d_plist      = nb->plist[iloc];
 491
 492     if (d_plist->na_c < 0)
 493     {
 494         d_plist->na_c = h_plist->na_ci;
 495     }
 496     else
 497     {
 498         if (d_plist->na_c != h_plist->na_ci)
 499         {
 500             sprintf(sbuf, "In init_plist: the #atoms per cell has changed (from %d to %d)",
 501                     d_plist->na_c, h_plist->na_ci);
 502             gmx_incons(sbuf);
 503         }
 504     }
 505
 506     gpu_timers_t::Interaction& iTimers = nb->timers->interaction[iloc];
 507
 508     if (bDoTime)
 509     {
 510         iTimers.pl_h2d.openTimingRegion(deviceStream);
 511         iTimers.didPairlistH2D = true;
 512     }
 513
 514     // TODO most of this function is same in CUDA and OpenCL, move into the header
 515     const DeviceContext& deviceContext = *nb->deviceContext_;
 516
 517     reallocateDeviceBuffer(&d_plist->sci, h_plist->sci.size(), &d_plist->nsci, &d_plist->sci_nalloc,
 518                            deviceContext);
 519     copyToDeviceBuffer(&d_plist->sci, h_plist->sci.data(), 0, h_plist->sci.size(), deviceStream,
 520                        GpuApiCallBehavior::Async, bDoTime ? iTimers.pl_h2d.fetchNextEvent() : nullptr);
 521
 522     reallocateDeviceBuffer(&d_plist->cj4, h_plist->cj4.size(), &d_plist->ncj4, &d_plist->cj4_nalloc,
 523                            deviceContext);
 524     copyToDeviceBuffer(&d_plist->cj4, h_plist->cj4.data(), 0, h_plist->cj4.size(), deviceStream,
 525                        GpuApiCallBehavior::Async, bDoTime ? iTimers.pl_h2d.fetchNextEvent() : nullptr);
 526
 527     reallocateDeviceBuffer(&d_plist->imask, h_plist->cj4.size() * c_nbnxnGpuClusterpairSplit,
 528                            &d_plist->nimask, &d_plist->imask_nalloc, deviceContext);
 529
 530     reallocateDeviceBuffer(&d_plist->excl, h_plist->excl.size(), &d_plist->nexcl,
 531                            &d_plist->excl_nalloc, deviceContext);
 532     copyToDeviceBuffer(&d_plist->excl, h_plist->excl.data(), 0, h_plist->excl.size(), deviceStream,
 533                        GpuApiCallBehavior::Async, bDoTime ? iTimers.pl_h2d.fetchNextEvent() : nullptr);
 534
 535     if (bDoTime)
 536     {
 537         iTimers.pl_h2d.closeTimingRegion(deviceStream);
 538     }
 539
 540     /* need to prune the pair list during the next step */
 541     d_plist->haveFreshList = true;
 542 }
 543
 544 //! This function is documented in the header file
 545 void gpu_upload_shiftvec(NbnxmGpu* nb, const nbnxn_atomdata_t* nbatom)
 546 {
 547     cl_atomdata_t*      adat         = nb->atdat;
 548     const DeviceStream& deviceStream = *nb->deviceStreams[InteractionLocality::Local];
 549
 550     /* only if we have a dynamic box */
 551     if (nbatom->bDynamicBox || !adat->bShiftVecUploaded)
 552     {
 553         GMX_ASSERT(sizeof(float) * DIM == sizeof(*nbatom->shift_vec.data()),
 554                    "Sizes of host- and device-side shift vectors should be the same.");
 555         copyToDeviceBuffer(&adat->shift_vec, reinterpret_cast<const float*>(nbatom->shift_vec.data()),
 556                            0, SHIFTS * DIM, deviceStream, GpuApiCallBehavior::Async, nullptr);
 557         adat->bShiftVecUploaded = CL_TRUE;
 558     }
 559 }
 560
 561 //! This function is documented in the header file
 562 void gpu_init_atomdata(NbnxmGpu* nb, const nbnxn_atomdata_t* nbat)
 563 {
 564     cl_int               cl_error;
 565     int                  nalloc, natoms;
 566     bool                 realloced;
 567     bool                 bDoTime       = nb->bDoTime;
 568     cl_timers_t*         timers        = nb->timers;
 569     cl_atomdata_t*       d_atdat       = nb->atdat;
 570     const DeviceContext& deviceContext = *nb->deviceContext_;
 571     const DeviceStream&  deviceStream  = *nb->deviceStreams[InteractionLocality::Local];
 572
 573     natoms    = nbat->numAtoms();
 574     realloced = false;
 575
 576     if (bDoTime)
 577     {
 578         /* time async copy */
 579         timers->atdat.openTimingRegion(deviceStream);
 580     }
 581
 582     /* need to reallocate if we have to copy more atoms than the amount of space
 583        available and only allocate if we haven't initialized yet, i.e d_atdat->natoms == -1 */
 584     if (natoms > d_atdat->nalloc)
 585     {
 586         nalloc = over_alloc_small(natoms);
 587
 588         /* free up first if the arrays have already been initialized */
 589         if (d_atdat->nalloc != -1)
 590         {
 591             freeDeviceBuffer(&d_atdat->f);
 592             freeDeviceBuffer(&d_atdat->xq);
 593             freeDeviceBuffer(&d_atdat->lj_comb);
 594             freeDeviceBuffer(&d_atdat->atom_types);
 595         }
 596
 597
 598         allocateDeviceBuffer(&d_atdat->f, nalloc * DIM, deviceContext);
 599         allocateDeviceBuffer(&d_atdat->xq, nalloc * (DIM + 1), deviceContext);
 600
 601         if (useLjCombRule(nb->nbparam->vdwtype))
 602         {
 603             // Two Lennard-Jones parameters per atom
 604             allocateDeviceBuffer(&d_atdat->lj_comb, nalloc * 2, deviceContext);
 605         }
 606         else
 607         {
 608             allocateDeviceBuffer(&d_atdat->atom_types, nalloc, deviceContext);
 609         }
 610
 611         d_atdat->nalloc = nalloc;
 612         realloced       = true;
 613     }
 614
 615     d_atdat->natoms       = natoms;
 616     d_atdat->natoms_local = nbat->natoms_local;
 617
 618     /* need to clear GPU f output if realloc happened */
 619     if (realloced)
 620     {
 621         nbnxn_ocl_clear_f(nb, nalloc);
 622     }
 623
 624     if (useLjCombRule(nb->nbparam->vdwtype))
 625     {
 626         GMX_ASSERT(sizeof(float) == sizeof(*nbat->params().lj_comb.data()),
 627                    "Size of the LJ parameters element should be equal to the size of float2.");
 628         copyToDeviceBuffer(&d_atdat->lj_comb, nbat->params().lj_comb.data(), 0, 2 * natoms,
 629                            deviceStream, GpuApiCallBehavior::Async,
 630                            bDoTime ? timers->atdat.fetchNextEvent() : nullptr);
 631     }
 632     else
 633     {
 634         GMX_ASSERT(sizeof(int) == sizeof(*nbat->params().type.data()),
 635                    "Sizes of host- and device-side atom types should be the same.");
 636         copyToDeviceBuffer(&d_atdat->atom_types, nbat->params().type.data(), 0, natoms, deviceStream,
 637                            GpuApiCallBehavior::Async, bDoTime ? timers->atdat.fetchNextEvent() : nullptr);
 638     }
 639
 640     if (bDoTime)
 641     {
 642         timers->atdat.closeTimingRegion(deviceStream);
 643     }
 644
 645     /* kick off the tasks enqueued above to ensure concurrency with the search */
 646     cl_error = clFlush(deviceStream.stream());
 647     GMX_RELEASE_ASSERT(cl_error == CL_SUCCESS,
 648                        ("clFlush failed: " + ocl_get_error_string(cl_error)).c_str());
 649 }
 650
 651 /*! \brief Releases an OpenCL kernel pointer */
 652 static void free_kernel(cl_kernel* kernel_ptr)
 653 {
 654     cl_int gmx_unused cl_error;
 655
 656     GMX_ASSERT(kernel_ptr, "Need a valid kernel pointer");
 657
 658     if (*kernel_ptr)
 659     {
 660         cl_error = clReleaseKernel(*kernel_ptr);
 661         GMX_RELEASE_ASSERT(cl_error == CL_SUCCESS,
 662                            ("clReleaseKernel failed: " + ocl_get_error_string(cl_error)).c_str());
 663
 664         *kernel_ptr = nullptr;
 665     }
 666 }
 667
 668 /*! \brief Releases a list of OpenCL kernel pointers */
 669 static void free_kernels(cl_kernel* kernels, int count)
 670 {
 671     int i;
 672
 673     for (i = 0; i < count; i++)
 674     {
 675         free_kernel(kernels + i);
 676     }
 677 }
 678
 679 /*! \brief Free the OpenCL program.
 680  *
 681  *  The function releases the OpenCL program assuciated with the
 682  *  device that the calling PP rank is running on.
 683  *
 684  *  \param program [in]  OpenCL program to release.
 685  */
 686 static void freeGpuProgram(cl_program program)
 687 {
 688     if (program)
 689     {
 690         cl_int cl_error = clReleaseProgram(program);
 691         GMX_RELEASE_ASSERT(cl_error == CL_SUCCESS,
 692                            ("clReleaseProgram failed: " + ocl_get_error_string(cl_error)).c_str());
 693         program = nullptr;
 694     }
 695 }
 696
 697 //! This function is documented in the header file
 698 void gpu_free(NbnxmGpu* nb)
 699 {
 700     if (nb == nullptr)
 701     {
 702         return;
 703     }
 704
 705     /* Free kernels */
 706     int kernel_count = sizeof(nb->kernel_ener_noprune_ptr) / sizeof(nb->kernel_ener_noprune_ptr[0][0]);
 707     free_kernels(nb->kernel_ener_noprune_ptr[0], kernel_count);
 708
 709     kernel_count = sizeof(nb->kernel_ener_prune_ptr) / sizeof(nb->kernel_ener_prune_ptr[0][0]);
 710     free_kernels(nb->kernel_ener_prune_ptr[0], kernel_count);
 711
 712     kernel_count = sizeof(nb->kernel_noener_noprune_ptr) / sizeof(nb->kernel_noener_noprune_ptr[0][0]);
 713     free_kernels(nb->kernel_noener_noprune_ptr[0], kernel_count);
 714
 715     kernel_count = sizeof(nb->kernel_noener_prune_ptr) / sizeof(nb->kernel_noener_prune_ptr[0][0]);
 716     free_kernels(nb->kernel_noener_prune_ptr[0], kernel_count);
 717
 718     free_kernel(&(nb->kernel_zero_e_fshift));
 719
 720     /* Free atdat */
 721     freeDeviceBuffer(&(nb->atdat->xq));
 722     freeDeviceBuffer(&(nb->atdat->f));
 723     freeDeviceBuffer(&(nb->atdat->e_lj));
 724     freeDeviceBuffer(&(nb->atdat->e_el));
 725     freeDeviceBuffer(&(nb->atdat->fshift));
 726     freeDeviceBuffer(&(nb->atdat->lj_comb));
 727     freeDeviceBuffer(&(nb->atdat->atom_types));
 728     freeDeviceBuffer(&(nb->atdat->shift_vec));
 729     sfree(nb->atdat);
 730
 731     /* Free nbparam */
 732     freeDeviceBuffer(&(nb->nbparam->nbfp));
 733     freeDeviceBuffer(&(nb->nbparam->nbfp_comb));
 734     freeDeviceBuffer(&(nb->nbparam->coulomb_tab));
 735     sfree(nb->nbparam);
 736
 737     /* Free plist */
 738     auto* plist = nb->plist[InteractionLocality::Local];
 739     freeDeviceBuffer(&plist->sci);
 740     freeDeviceBuffer(&plist->cj4);
 741     freeDeviceBuffer(&plist->imask);
 742     freeDeviceBuffer(&plist->excl);
 743     sfree(plist);
 744     if (nb->bUseTwoStreams)
 745     {
 746         auto* plist_nl = nb->plist[InteractionLocality::NonLocal];
 747         freeDeviceBuffer(&plist_nl->sci);
 748         freeDeviceBuffer(&plist_nl->cj4);
 749         freeDeviceBuffer(&plist_nl->imask);
 750         freeDeviceBuffer(&plist_nl->excl);
 751         sfree(plist_nl);
 752     }
 753
 754     /* Free nbst */
 755     pfree(nb->nbst.e_lj);
 756     nb->nbst.e_lj = nullptr;
 757
 758     pfree(nb->nbst.e_el);
 759     nb->nbst.e_el = nullptr;
 760
 761     pfree(nb->nbst.fshift);
 762     nb->nbst.fshift = nullptr;
 763
 764     /* Free other events */
 765     if (nb->nonlocal_done)
 766     {
 767         clReleaseEvent(nb->nonlocal_done);
 768         nb->nonlocal_done = nullptr;
 769     }
 770     if (nb->misc_ops_and_local_H2D_done)
 771     {
 772         clReleaseEvent(nb->misc_ops_and_local_H2D_done);
 773         nb->misc_ops_and_local_H2D_done = nullptr;
 774     }
 775
 776     freeGpuProgram(nb->dev_rundata->program);
 777     delete nb->dev_rundata;
 778
 779     /* Free timers and timings */
 780     delete nb->timers;
 781     sfree(nb->timings);
 782     delete nb;
 783
 784     if (debug)
 785     {
 786         fprintf(debug, "Cleaned up OpenCL data structures.\n");
 787     }
 788 }
 789
 790 //! This function is documented in the header file
 791 gmx_wallclock_gpu_nbnxn_t* gpu_get_timings(NbnxmGpu* nb)
 792 {
 793     return (nb != nullptr && nb->bDoTime) ? nb->timings : nullptr;
 794 }
 795
 796 //! This function is documented in the header file
 797 void gpu_reset_timings(nonbonded_verlet_t* nbv)
 798 {
 799     if (nbv->gpu_nbv && nbv->gpu_nbv->bDoTime)
 800     {
 801         init_timings(nbv->gpu_nbv->timings);
 802     }
 803 }
 804
 805 //! This function is documented in the header file
 806 int gpu_min_ci_balanced(NbnxmGpu* nb)
 807 {
 808     return nb != nullptr ? gpu_min_ci_balanced_factor * nb->deviceContext_->deviceInfo().compute_units : 0;
 809 }
 810
 811 //! This function is documented in the header file
 812 gmx_bool gpu_is_kernel_ewald_analytical(const NbnxmGpu* nb)
 813 {
 814     return ((nb->nbparam->eeltype == eelTypeEWALD_ANA) || (nb->nbparam->eeltype == eelTypeEWALD_ANA_TWIN));
 815 }
 816
 817 } // namespace Nbnxm