src/gromacs/nbnxm/opencl/nbnxm_ocl.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.h
  38  *
  39  *  \author Anca Hamuraru <anca@streamcomputing.eu>
  40  *  \author Teemu Virolainen <teemu@streamcomputing.eu>
  41  *  \author Dimitrios Karkoulis <dimitris.karkoulis@gmail.com>
  42  *  \author Szilárd Páll <pall.szilard@gmail.com>
  43  *  \ingroup module_nbnxm
  44  *
  45  *  TODO (psz):
  46  *  - Add a static const cl_uint c_pruneKernelWorkDim / c_nbnxnKernelWorkDim = 3;
  47  *  - Rework the copying of OCL data structures done before every invocation of both
  48  *    nb and prune kernels (using fillin_ocl_structures); also consider at the same
  49  *    time calling clSetKernelArg only on the updated parameters (if tracking changed
  50  *    parameters is feasible);
  51  *  - Consider using the event_wait_list argument to clEnqueueNDRangeKernel to mark
  52  *    dependencies on the kernel launched: e.g. the non-local nb kernel's dependency
  53  *    on the misc_ops_and_local_H2D_done event could be better expressed this way.
  54  *
  55  *  - Consider extracting common sections of the OpenCL and CUDA nbnxn logic, e.g:
  56  *    - in nbnxn_gpu_launch_kernel_pruneonly() the pre- and post-kernel launch logic
  57  *      is identical in the two implementations, so a 3-way split might allow sharing
  58  *      code;
  59  *    -
  60  *
  61  */
  62 #include "gmxpre.h"
  63
  64 #include <assert.h>
  65 #include <stdlib.h>
  66
  67 #if defined(_MSVC)
  68 #    include <limits>
  69 #endif
  70
  71 #include "thread_mpi/atomic.h"
  72
  73 #include "gromacs/gpu_utils/gputraits_ocl.h"
  74 #include "gromacs/gpu_utils/oclutils.h"
  75 #include "gromacs/hardware/hw_info.h"
  76 #include "gromacs/mdtypes/simulation_workload.h"
  77 #include "gromacs/nbnxm/atomdata.h"
  78 #include "gromacs/nbnxm/gpu_common.h"
  79 #include "gromacs/nbnxm/gpu_common_utils.h"
  80 #include "gromacs/nbnxm/gpu_data_mgmt.h"
  81 #include "gromacs/nbnxm/nbnxm.h"
  82 #include "gromacs/nbnxm/nbnxm_gpu.h"
  83 #include "gromacs/nbnxm/pairlist.h"
  84 #include "gromacs/pbcutil/ishift.h"
  85 #include "gromacs/timing/gpu_timing.h"
  86 #include "gromacs/utility/cstringutil.h"
  87 #include "gromacs/utility/fatalerror.h"
  88 #include "gromacs/utility/gmxassert.h"
  89
  90 #include "nbnxm_ocl_internal.h"
  91 #include "nbnxm_ocl_types.h"
  92
  93 namespace Nbnxm
  94 {
  95
  96 /*! \brief Convenience constants */
  97 //@{
  98 static constexpr int c_clSize = c_nbnxnGpuClusterSize;
  99 //@}
 100
 101
 102 /*! \brief Validates the input global work size parameter.
 103  */
 104 static inline void validate_global_work_size(const KernelLaunchConfig& config,
 105                                              int                       work_dim,
 106                                              const gmx_device_info_t*  dinfo)
 107 {
 108     cl_uint device_size_t_size_bits;
 109     cl_uint host_size_t_size_bits;
 110
 111     GMX_ASSERT(dinfo, "Need a valid device info object");
 112
 113     size_t global_work_size[3];
 114     GMX_ASSERT(work_dim <= 3, "Not supporting hyper-grids just yet");
 115     for (int i = 0; i < work_dim; i++)
 116     {
 117         global_work_size[i] = config.blockSize[i] * config.gridSize[i];
 118     }
 119
 120     /* Each component of a global_work_size must not exceed the range given by the
 121        sizeof(device size_t) for the device on which the kernel execution will
 122        be enqueued. See:
 123        https://www.khronos.org/registry/cl/sdk/1.0/docs/man/xhtml/clEnqueueNDRangeKernel.html
 124      */
 125     device_size_t_size_bits = dinfo->adress_bits;
 126     host_size_t_size_bits   = static_cast<cl_uint>(sizeof(size_t) * 8);
 127
 128     /* If sizeof(host size_t) <= sizeof(device size_t)
 129             => global_work_size components will always be valid
 130        else
 131             => get device limit for global work size and
 132             compare it against each component of global_work_size.
 133      */
 134     if (host_size_t_size_bits > device_size_t_size_bits)
 135     {
 136         size_t device_limit;
 137
 138         device_limit = (1ULL << device_size_t_size_bits) - 1;
 139
 140         for (int i = 0; i < work_dim; i++)
 141         {
 142             if (global_work_size[i] > device_limit)
 143             {
 144                 gmx_fatal(
 145                         FARGS,
 146                         "Watch out, the input system is too large to simulate!\n"
 147                         "The number of nonbonded work units (=number of super-clusters) exceeds the"
 148                         "device capabilities. Global work size limit exceeded (%zu > %zu)!",
 149                         global_work_size[i], device_limit);
 150             }
 151         }
 152     }
 153 }
 154
 155 /* Constant arrays listing non-bonded kernel function names. The arrays are
 156  * organized in 2-dim arrays by: electrostatics and VDW type.
 157  *
 158  *  Note that the row- and column-order of function pointers has to match the
 159  *  order of corresponding enumerated electrostatics and vdw types, resp.,
 160  *  defined in nbnxm_ocl_types.h.
 161  */
 162
 163 /*! \brief Force-only kernel function names. */
 164 static const char* nb_kfunc_noener_noprune_ptr[eelOclNR][evdwOclNR] = {
 165     { "nbnxn_kernel_ElecCut_VdwLJ_F_opencl", "nbnxn_kernel_ElecCut_VdwLJCombGeom_F_opencl",
 166       "nbnxn_kernel_ElecCut_VdwLJCombLB_F_opencl", "nbnxn_kernel_ElecCut_VdwLJFsw_F_opencl",
 167       "nbnxn_kernel_ElecCut_VdwLJPsw_F_opencl", "nbnxn_kernel_ElecCut_VdwLJEwCombGeom_F_opencl",
 168       "nbnxn_kernel_ElecCut_VdwLJEwCombLB_F_opencl" },
 169     { "nbnxn_kernel_ElecRF_VdwLJ_F_opencl", "nbnxn_kernel_ElecRF_VdwLJCombGeom_F_opencl",
 170       "nbnxn_kernel_ElecRF_VdwLJCombLB_F_opencl", "nbnxn_kernel_ElecRF_VdwLJFsw_F_opencl",
 171       "nbnxn_kernel_ElecRF_VdwLJPsw_F_opencl", "nbnxn_kernel_ElecRF_VdwLJEwCombGeom_F_opencl",
 172       "nbnxn_kernel_ElecRF_VdwLJEwCombLB_F_opencl" },
 173     { "nbnxn_kernel_ElecEwQSTab_VdwLJ_F_opencl", "nbnxn_kernel_ElecEwQSTab_VdwLJCombGeom_F_opencl",
 174       "nbnxn_kernel_ElecEwQSTab_VdwLJCombLB_F_opencl", "nbnxn_kernel_ElecEwQSTab_VdwLJFsw_F_opencl",
 175       "nbnxn_kernel_ElecEwQSTab_VdwLJPsw_F_opencl",
 176       "nbnxn_kernel_ElecEwQSTab_VdwLJEwCombGeom_F_opencl",
 177       "nbnxn_kernel_ElecEwQSTab_VdwLJEwCombLB_F_opencl" },
 178     { "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJ_F_opencl",
 179       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJCombGeom_F_opencl",
 180       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJCombLB_F_opencl",
 181       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJFsw_F_opencl",
 182       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJPsw_F_opencl",
 183       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJEwCombGeom_F_opencl",
 184       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJEwCombLB_F_opencl" },
 185     { "nbnxn_kernel_ElecEw_VdwLJ_F_opencl", "nbnxn_kernel_ElecEw_VdwLJCombGeom_F_opencl",
 186       "nbnxn_kernel_ElecEw_VdwLJCombLB_F_opencl", "nbnxn_kernel_ElecEw_VdwLJFsw_F_opencl",
 187       "nbnxn_kernel_ElecEw_VdwLJPsw_F_opencl", "nbnxn_kernel_ElecEw_VdwLJEwCombGeom_F_opencl",
 188       "nbnxn_kernel_ElecEw_VdwLJEwCombLB_F_opencl" },
 189     { "nbnxn_kernel_ElecEwTwinCut_VdwLJ_F_opencl",
 190       "nbnxn_kernel_ElecEwTwinCut_VdwLJCombGeom_F_opencl",
 191       "nbnxn_kernel_ElecEwTwinCut_VdwLJCombLB_F_opencl",
 192       "nbnxn_kernel_ElecEwTwinCut_VdwLJFsw_F_opencl", "nbnxn_kernel_ElecEwTwinCut_VdwLJPsw_F_opencl",
 193       "nbnxn_kernel_ElecEwTwinCut_VdwLJEwCombGeom_F_opencl",
 194       "nbnxn_kernel_ElecEwTwinCut_VdwLJEwCombLB_F_opencl" }
 195 };
 196
 197 /*! \brief Force + energy kernel function pointers. */
 198 static const char* nb_kfunc_ener_noprune_ptr[eelOclNR][evdwOclNR] = {
 199     { "nbnxn_kernel_ElecCut_VdwLJ_VF_opencl", "nbnxn_kernel_ElecCut_VdwLJCombGeom_VF_opencl",
 200       "nbnxn_kernel_ElecCut_VdwLJCombLB_VF_opencl", "nbnxn_kernel_ElecCut_VdwLJFsw_VF_opencl",
 201       "nbnxn_kernel_ElecCut_VdwLJPsw_VF_opencl", "nbnxn_kernel_ElecCut_VdwLJEwCombGeom_VF_opencl",
 202       "nbnxn_kernel_ElecCut_VdwLJEwCombLB_VF_opencl" },
 203     { "nbnxn_kernel_ElecRF_VdwLJ_VF_opencl", "nbnxn_kernel_ElecRF_VdwLJCombGeom_VF_opencl",
 204       "nbnxn_kernel_ElecRF_VdwLJCombLB_VF_opencl", "nbnxn_kernel_ElecRF_VdwLJFsw_VF_opencl",
 205       "nbnxn_kernel_ElecRF_VdwLJPsw_VF_opencl", "nbnxn_kernel_ElecRF_VdwLJEwCombGeom_VF_opencl",
 206       "nbnxn_kernel_ElecRF_VdwLJEwCombLB_VF_opencl" },
 207     { "nbnxn_kernel_ElecEwQSTab_VdwLJ_VF_opencl", "nbnxn_kernel_ElecEwQSTab_VdwLJCombGeom_VF_opencl",
 208       "nbnxn_kernel_ElecEwQSTab_VdwLJCombLB_VF_opencl",
 209       "nbnxn_kernel_ElecEwQSTab_VdwLJFsw_VF_opencl", "nbnxn_kernel_ElecEwQSTab_VdwLJPsw_VF_opencl",
 210       "nbnxn_kernel_ElecEwQSTab_VdwLJEwCombGeom_VF_opencl",
 211       "nbnxn_kernel_ElecEwQSTab_VdwLJEwCombLB_VF_opencl" },
 212     { "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJ_VF_opencl",
 213       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJCombGeom_VF_opencl",
 214       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJCombLB_VF_opencl",
 215       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJFsw_VF_opencl",
 216       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJPsw_VF_opencl",
 217       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJEwCombGeom_VF_opencl",
 218       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJEwCombLB_VF_opencl" },
 219     { "nbnxn_kernel_ElecEw_VdwLJ_VF_opencl", "nbnxn_kernel_ElecEw_VdwLJCombGeom_VF_opencl",
 220       "nbnxn_kernel_ElecEw_VdwLJCombLB_VF_opencl", "nbnxn_kernel_ElecEw_VdwLJFsw_VF_opencl",
 221       "nbnxn_kernel_ElecEw_VdwLJPsw_VF_opencl", "nbnxn_kernel_ElecEw_VdwLJEwCombGeom_VF_opencl",
 222       "nbnxn_kernel_ElecEw_VdwLJEwCombLB_VF_opencl" },
 223     { "nbnxn_kernel_ElecEwTwinCut_VdwLJ_VF_opencl",
 224       "nbnxn_kernel_ElecEwTwinCut_VdwLJCombGeom_VF_opencl",
 225       "nbnxn_kernel_ElecEwTwinCut_VdwLJCombLB_VF_opencl",
 226       "nbnxn_kernel_ElecEwTwinCut_VdwLJFsw_VF_opencl",
 227       "nbnxn_kernel_ElecEwTwinCut_VdwLJPsw_VF_opencl",
 228       "nbnxn_kernel_ElecEwTwinCut_VdwLJEwCombGeom_VF_opencl",
 229       "nbnxn_kernel_ElecEwTwinCut_VdwLJEwCombLB_VF_opencl" }
 230 };
 231
 232 /*! \brief Force + pruning kernel function pointers. */
 233 static const char* nb_kfunc_noener_prune_ptr[eelOclNR][evdwOclNR] = {
 234     { "nbnxn_kernel_ElecCut_VdwLJ_F_prune_opencl",
 235       "nbnxn_kernel_ElecCut_VdwLJCombGeom_F_prune_opencl",
 236       "nbnxn_kernel_ElecCut_VdwLJCombLB_F_prune_opencl",
 237       "nbnxn_kernel_ElecCut_VdwLJFsw_F_prune_opencl", "nbnxn_kernel_ElecCut_VdwLJPsw_F_prune_opencl",
 238       "nbnxn_kernel_ElecCut_VdwLJEwCombGeom_F_prune_opencl",
 239       "nbnxn_kernel_ElecCut_VdwLJEwCombLB_F_prune_opencl" },
 240     { "nbnxn_kernel_ElecRF_VdwLJ_F_prune_opencl", "nbnxn_kernel_ElecRF_VdwLJCombGeom_F_prune_opencl",
 241       "nbnxn_kernel_ElecRF_VdwLJCombLB_F_prune_opencl",
 242       "nbnxn_kernel_ElecRF_VdwLJFsw_F_prune_opencl", "nbnxn_kernel_ElecRF_VdwLJPsw_F_prune_opencl",
 243       "nbnxn_kernel_ElecRF_VdwLJEwCombGeom_F_prune_opencl",
 244       "nbnxn_kernel_ElecRF_VdwLJEwCombLB_F_prune_opencl" },
 245     { "nbnxn_kernel_ElecEwQSTab_VdwLJ_F_prune_opencl",
 246       "nbnxn_kernel_ElecEwQSTab_VdwLJCombGeom_F_prune_opencl",
 247       "nbnxn_kernel_ElecEwQSTab_VdwLJCombLB_F_prune_opencl",
 248       "nbnxn_kernel_ElecEwQSTab_VdwLJFsw_F_prune_opencl",
 249       "nbnxn_kernel_ElecEwQSTab_VdwLJPsw_F_prune_opencl",
 250       "nbnxn_kernel_ElecEwQSTab_VdwLJEwCombGeom_F_prune_opencl",
 251       "nbnxn_kernel_ElecEwQSTab_VdwLJEwCombLB_F_prune_opencl" },
 252     { "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJ_F_prune_opencl",
 253       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJCombGeom_F_prune_opencl",
 254       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJCombLB_F_prune_opencl",
 255       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJFsw_F_prune_opencl",
 256       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJPsw_F_prune_opencl",
 257       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJEwCombGeom_F_prune_opencl",
 258       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJEwCombLB_F_prune_opencl" },
 259     { "nbnxn_kernel_ElecEw_VdwLJ_F_prune_opencl", "nbnxn_kernel_ElecEw_VdwLJCombGeom_F_prune_opencl",
 260       "nbnxn_kernel_ElecEw_VdwLJCombLB_F_prune_opencl",
 261       "nbnxn_kernel_ElecEw_VdwLJFsw_F_prune_opencl", "nbnxn_kernel_ElecEw_VdwLJPsw_F_prune_opencl",
 262       "nbnxn_kernel_ElecEw_VdwLJEwCombGeom_F_prune_opencl",
 263       "nbnxn_kernel_ElecEw_VdwLJEwCombLB_F_prune_opencl" },
 264     { "nbnxn_kernel_ElecEwTwinCut_VdwLJ_F_prune_opencl",
 265       "nbnxn_kernel_ElecEwTwinCut_VdwLJCombGeom_F_prune_opencl",
 266       "nbnxn_kernel_ElecEwTwinCut_VdwLJCombLB_F_prune_opencl",
 267       "nbnxn_kernel_ElecEwTwinCut_VdwLJFsw_F_prune_opencl",
 268       "nbnxn_kernel_ElecEwTwinCut_VdwLJPsw_F_prune_opencl",
 269       "nbnxn_kernel_ElecEwTwinCut_VdwLJEwCombGeom_F_prune_opencl",
 270       "nbnxn_kernel_ElecEwTwinCut_VdwLJEwCombLB_F_prune_opencl" }
 271 };
 272
 273 /*! \brief Force + energy + pruning kernel function pointers. */
 274 static const char* nb_kfunc_ener_prune_ptr[eelOclNR][evdwOclNR] = {
 275     { "nbnxn_kernel_ElecCut_VdwLJ_VF_prune_opencl",
 276       "nbnxn_kernel_ElecCut_VdwLJCombGeom_VF_prune_opencl",
 277       "nbnxn_kernel_ElecCut_VdwLJCombLB_VF_prune_opencl",
 278       "nbnxn_kernel_ElecCut_VdwLJFsw_VF_prune_opencl",
 279       "nbnxn_kernel_ElecCut_VdwLJPsw_VF_prune_opencl",
 280       "nbnxn_kernel_ElecCut_VdwLJEwCombGeom_VF_prune_opencl",
 281       "nbnxn_kernel_ElecCut_VdwLJEwCombLB_VF_prune_opencl" },
 282     { "nbnxn_kernel_ElecRF_VdwLJ_VF_prune_opencl",
 283       "nbnxn_kernel_ElecRF_VdwLJCombGeom_VF_prune_opencl",
 284       "nbnxn_kernel_ElecRF_VdwLJCombLB_VF_prune_opencl",
 285       "nbnxn_kernel_ElecRF_VdwLJFsw_VF_prune_opencl", "nbnxn_kernel_ElecRF_VdwLJPsw_VF_prune_opencl",
 286       "nbnxn_kernel_ElecRF_VdwLJEwCombGeom_VF_prune_opencl",
 287       "nbnxn_kernel_ElecRF_VdwLJEwCombLB_VF_prune_opencl" },
 288     { "nbnxn_kernel_ElecEwQSTab_VdwLJ_VF_prune_opencl",
 289       "nbnxn_kernel_ElecEwQSTab_VdwLJCombGeom_VF_prune_opencl",
 290       "nbnxn_kernel_ElecEwQSTab_VdwLJCombLB_VF_prune_opencl",
 291       "nbnxn_kernel_ElecEwQSTab_VdwLJFsw_VF_prune_opencl",
 292       "nbnxn_kernel_ElecEwQSTab_VdwLJPsw_VF_prune_opencl",
 293       "nbnxn_kernel_ElecEwQSTab_VdwLJEwCombGeom_VF_prune_opencl",
 294       "nbnxn_kernel_ElecEwQSTab_VdwLJEwCombLB_VF_prune_opencl" },
 295     { "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJ_VF_prune_opencl",
 296       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJCombGeom_VF_prune_opencl",
 297       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJCombLB_VF_prune_opencl",
 298       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJFsw_VF_prune_opencl",
 299       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJPsw_VF_prune_opencl",
 300       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJEwCombGeom_VF_prune_opencl",
 301       "nbnxn_kernel_ElecEwQSTabTwinCut_VdwLJEwCombLB_VF_prune_opencl" },
 302     { "nbnxn_kernel_ElecEw_VdwLJ_VF_prune_opencl",
 303       "nbnxn_kernel_ElecEw_VdwLJCombGeom_VF_prune_opencl",
 304       "nbnxn_kernel_ElecEw_VdwLJCombLB_VF_prune_opencl",
 305       "nbnxn_kernel_ElecEw_VdwLJFsw_VF_prune_opencl", "nbnxn_kernel_ElecEw_VdwLJPsw_VF_prune_opencl",
 306       "nbnxn_kernel_ElecEw_VdwLJEwCombGeom_VF_prune_opencl",
 307       "nbnxn_kernel_ElecEw_VdwLJEwCombLB_VF_prune_opencl" },
 308     { "nbnxn_kernel_ElecEwTwinCut_VdwLJ_VF_prune_opencl",
 309       "nbnxn_kernel_ElecEwTwinCut_VdwLJCombGeom_VF_prune_opencl",
 310       "nbnxn_kernel_ElecEwTwinCut_VdwLJCombLB_VF_prune_opencl",
 311       "nbnxn_kernel_ElecEwTwinCut_VdwLJFsw_VF_prune_opencl",
 312       "nbnxn_kernel_ElecEwTwinCut_VdwLJPsw_VF_prune_opencl",
 313       "nbnxn_kernel_ElecEwTwinCut_VdwLJEwCombGeom_VF_prune_opencl",
 314       "nbnxn_kernel_ElecEwTwinCut_VdwLJEwCombLB_VF_prune_opencl" }
 315 };
 316
 317 /*! \brief Return a pointer to the prune kernel version to be executed at the current invocation.
 318  *
 319  * \param[in] kernel_pruneonly  array of prune kernel objects
 320  * \param[in] firstPrunePass    true if the first pruning pass is being executed
 321  */
 322 static inline cl_kernel selectPruneKernel(cl_kernel kernel_pruneonly[], bool firstPrunePass)
 323 {
 324     cl_kernel* kernelPtr;
 325
 326     if (firstPrunePass)
 327     {
 328         kernelPtr = &(kernel_pruneonly[epruneFirst]);
 329     }
 330     else
 331     {
 332         kernelPtr = &(kernel_pruneonly[epruneRolling]);
 333     }
 334     // TODO: consider creating the prune kernel object here to avoid a
 335     // clCreateKernel for the rolling prune kernel if this is not needed.
 336     return *kernelPtr;
 337 }
 338
 339 /*! \brief Return a pointer to the kernel version to be executed at the current step.
 340  *  OpenCL kernel objects are cached in nb. If the requested kernel is not
 341  *  found in the cache, it will be created and the cache will be updated.
 342  */
 343 static inline cl_kernel select_nbnxn_kernel(NbnxmGpu* nb, int eeltype, int evdwtype, bool bDoEne, bool bDoPrune)
 344 {
 345     const char* kernel_name_to_run;
 346     cl_kernel*  kernel_ptr;
 347     cl_int      cl_error;
 348
 349     GMX_ASSERT(eeltype < eelOclNR,
 350                "The electrostatics type requested is not implemented in the OpenCL kernels.");
 351     GMX_ASSERT(evdwtype < evdwOclNR,
 352                "The VdW type requested is not implemented in the OpenCL kernels.");
 353
 354     if (bDoEne)
 355     {
 356         if (bDoPrune)
 357         {
 358             kernel_name_to_run = nb_kfunc_ener_prune_ptr[eeltype][evdwtype];
 359             kernel_ptr         = &(nb->kernel_ener_prune_ptr[eeltype][evdwtype]);
 360         }
 361         else
 362         {
 363             kernel_name_to_run = nb_kfunc_ener_noprune_ptr[eeltype][evdwtype];
 364             kernel_ptr         = &(nb->kernel_ener_noprune_ptr[eeltype][evdwtype]);
 365         }
 366     }
 367     else
 368     {
 369         if (bDoPrune)
 370         {
 371             kernel_name_to_run = nb_kfunc_noener_prune_ptr[eeltype][evdwtype];
 372             kernel_ptr         = &(nb->kernel_noener_prune_ptr[eeltype][evdwtype]);
 373         }
 374         else
 375         {
 376             kernel_name_to_run = nb_kfunc_noener_noprune_ptr[eeltype][evdwtype];
 377             kernel_ptr         = &(nb->kernel_noener_noprune_ptr[eeltype][evdwtype]);
 378         }
 379     }
 380
 381     if (nullptr == kernel_ptr[0])
 382     {
 383         *kernel_ptr = clCreateKernel(nb->dev_rundata->program, kernel_name_to_run, &cl_error);
 384         GMX_ASSERT(cl_error == CL_SUCCESS,
 385                    ("clCreateKernel failed: " + ocl_get_error_string(cl_error)).c_str());
 386     }
 387
 388     return *kernel_ptr;
 389 }
 390
 391 /*! \brief Calculates the amount of shared memory required by the nonbonded kernel in use.
 392  */
 393 static inline int calc_shmem_required_nonbonded(int vdwType, bool bPrefetchLjParam)
 394 {
 395     int shmem;
 396
 397     /* size of shmem (force-buffers/xq/atom type preloading) */
 398     /* NOTE: with the default kernel on sm3.0 we need shmem only for pre-loading */
 399     /* i-atom x+q in shared memory */
 400     shmem = c_nbnxnGpuNumClusterPerSupercluster * c_clSize * sizeof(float) * 4; /* xqib */
 401     /* cj in shared memory, for both warps separately
 402      * TODO: in the "nowarp kernels we load cj only once  so the factor 2 is not needed.
 403      */
 404     shmem += 2 * c_nbnxnGpuJgroupSize * sizeof(int); /* cjs  */
 405     if (bPrefetchLjParam)
 406     {
 407         if (useLjCombRule(vdwType))
 408         {
 409             /* i-atom LJ combination parameters in shared memory */
 410             shmem += c_nbnxnGpuNumClusterPerSupercluster * c_clSize * 2
 411                      * sizeof(float); /* atib abused for ljcp, float2 */
 412         }
 413         else
 414         {
 415             /* i-atom types in shared memory */
 416             shmem += c_nbnxnGpuNumClusterPerSupercluster * c_clSize * sizeof(int); /* atib */
 417         }
 418     }
 419     /* force reduction buffers in shared memory */
 420     shmem += c_clSize * c_clSize * 3 * sizeof(float); /* f_buf */
 421     /* Warp vote. In fact it must be * number of warps in block.. */
 422     shmem += sizeof(cl_uint) * 2; /* warp_any */
 423     return shmem;
 424 }
 425
 426 /*! \brief Initializes data structures that are going to be sent to the OpenCL device.
 427  *
 428  *  The device can't use the same data structures as the host for two main reasons:
 429  *  - OpenCL restrictions (pointers are not accepted inside data structures)
 430  *  - some host side fields are not needed for the OpenCL kernels.
 431  *
 432  *  This function is called before the launch of both nbnxn and prune kernels.
 433  */
 434 static void fillin_ocl_structures(cl_nbparam_t* nbp, cl_nbparam_params_t* nbparams_params)
 435 {
 436     nbparams_params->coulomb_tab_scale = nbp->coulomb_tab_scale;
 437     nbparams_params->c_rf              = nbp->c_rf;
 438     nbparams_params->dispersion_shift  = nbp->dispersion_shift;
 439     nbparams_params->eeltype           = nbp->eeltype;
 440     nbparams_params->epsfac            = nbp->epsfac;
 441     nbparams_params->ewaldcoeff_lj     = nbp->ewaldcoeff_lj;
 442     nbparams_params->ewald_beta        = nbp->ewald_beta;
 443     nbparams_params->rcoulomb_sq       = nbp->rcoulomb_sq;
 444     nbparams_params->repulsion_shift   = nbp->repulsion_shift;
 445     nbparams_params->rlistOuter_sq     = nbp->rlistOuter_sq;
 446     nbparams_params->rvdw_sq           = nbp->rvdw_sq;
 447     nbparams_params->rlistInner_sq     = nbp->rlistInner_sq;
 448     nbparams_params->rvdw_switch       = nbp->rvdw_switch;
 449     nbparams_params->sh_ewald          = nbp->sh_ewald;
 450     nbparams_params->sh_lj_ewald       = nbp->sh_lj_ewald;
 451     nbparams_params->two_k_rf          = nbp->two_k_rf;
 452     nbparams_params->vdwtype           = nbp->vdwtype;
 453     nbparams_params->vdw_switch        = nbp->vdw_switch;
 454 }
 455
 456 /*! \brief Enqueues a wait for event completion.
 457  *
 458  * Then it releases the event and sets it to 0.
 459  * Don't use this function when more than one wait will be issued for the event.
 460  * Equivalent to Cuda Stream Sync. */
 461 static void sync_ocl_event(cl_command_queue stream, cl_event* ocl_event)
 462 {
 463     cl_int gmx_unused cl_error;
 464
 465     /* Enqueue wait */
 466     cl_error = clEnqueueBarrierWithWaitList(stream, 1, ocl_event, nullptr);
 467     GMX_RELEASE_ASSERT(CL_SUCCESS == cl_error, ocl_get_error_string(cl_error).c_str());
 468
 469     /* Release event and reset it to 0. It is ok to release it as enqueuewaitforevents performs implicit retain for events. */
 470     cl_error = clReleaseEvent(*ocl_event);
 471     GMX_ASSERT(cl_error == CL_SUCCESS,
 472                ("clReleaseEvent failed: " + ocl_get_error_string(cl_error)).c_str());
 473     *ocl_event = nullptr;
 474 }
 475
 476 /*! \brief Launch asynchronously the xq buffer host to device copy. */
 477 void gpu_copy_xq_to_gpu(NbnxmGpu* nb, const nbnxn_atomdata_t* nbatom, const AtomLocality atomLocality)
 478 {
 479     GMX_ASSERT(nb, "Need a valid nbnxn_gpu object");
 480
 481     const InteractionLocality iloc = gpuAtomToInteractionLocality(atomLocality);
 482
 483     /* local/nonlocal offset and length used for xq and f */
 484     int adat_begin, adat_len;
 485
 486     cl_atomdata_t*   adat   = nb->atdat;
 487     cl_plist_t*      plist  = nb->plist[iloc];
 488     cl_timers_t*     t      = nb->timers;
 489     cl_command_queue stream = nb->stream[iloc];
 490
 491     bool bDoTime = (nb->bDoTime) != 0;
 492
 493     /* Don't launch the non-local H2D copy if there is no dependent
 494        work to do: neither non-local nor other (e.g. bonded) work
 495        to do that has as input the nbnxn coordinates.
 496        Doing the same for the local kernel is more complicated, since the
 497        local part of the force array also depends on the non-local kernel.
 498        So to avoid complicating the code and to reduce the risk of bugs,
 499        we always call the local local x+q copy (and the rest of the local
 500        work in nbnxn_gpu_launch_kernel().
 501      */
 502     if ((iloc == InteractionLocality::NonLocal) && !haveGpuShortRangeWork(*nb, iloc))
 503     {
 504         plist->haveFreshList = false;
 505
 506         return;
 507     }
 508
 509     /* calculate the atom data index range based on locality */
 510     if (atomLocality == AtomLocality::Local)
 511     {
 512         adat_begin = 0;
 513         adat_len   = adat->natoms_local;
 514     }
 515     else
 516     {
 517         adat_begin = adat->natoms_local;
 518         adat_len   = adat->natoms - adat->natoms_local;
 519     }
 520
 521     /* beginning of timed HtoD section */
 522     if (bDoTime)
 523     {
 524         t->xf[atomLocality].nb_h2d.openTimingRegion(stream);
 525     }
 526
 527     /* HtoD x, q */
 528     ocl_copy_H2D_async(adat->xq, nbatom->x().data() + adat_begin * 4,
 529                        adat_begin * sizeof(float) * 4, adat_len * sizeof(float) * 4, stream,
 530                        bDoTime ? t->xf[atomLocality].nb_h2d.fetchNextEvent() : nullptr);
 531
 532     if (bDoTime)
 533     {
 534         t->xf[atomLocality].nb_h2d.closeTimingRegion(stream);
 535     }
 536
 537     /* When we get here all misc operations issues in the local stream as well as
 538        the local xq H2D are done,
 539        so we record that in the local stream and wait for it in the nonlocal one. */
 540     if (nb->bUseTwoStreams)
 541     {
 542         if (iloc == InteractionLocality::Local)
 543         {
 544             cl_int gmx_used_in_debug cl_error = clEnqueueMarkerWithWaitList(
 545                     stream, 0, nullptr, &(nb->misc_ops_and_local_H2D_done));
 546             GMX_ASSERT(cl_error == CL_SUCCESS,
 547                        ("clEnqueueMarkerWithWaitList failed: " + ocl_get_error_string(cl_error)).c_str());
 548
 549             /* Based on the v1.2 section 5.13 of the OpenCL spec, a flush is needed
 550              * in the local stream in order to be able to sync with the above event
 551              * from the non-local stream.
 552              */
 553             cl_error = clFlush(stream);
 554             GMX_ASSERT(cl_error == CL_SUCCESS,
 555                        ("clFlush failed: " + ocl_get_error_string(cl_error)).c_str());
 556         }
 557         else
 558         {
 559             sync_ocl_event(stream, &(nb->misc_ops_and_local_H2D_done));
 560         }
 561     }
 562 }
 563
 564
 565 /*! \brief Launch GPU kernel
 566
 567    As we execute nonbonded workload in separate queues, before launching
 568    the kernel we need to make sure that he following operations have completed:
 569    - atomdata allocation and related H2D transfers (every nstlist step);
 570    - pair list H2D transfer (every nstlist step);
 571    - shift vector H2D transfer (every nstlist step);
 572    - force (+shift force and energy) output clearing (every step).
 573
 574    These operations are issued in the local queue at the beginning of the step
 575    and therefore always complete before the local kernel launch. The non-local
 576    kernel is launched after the local on the same device/context, so this is
 577    inherently scheduled after the operations in the local stream (including the
 578    above "misc_ops").
 579    However, for the sake of having a future-proof implementation, we use the
 580    misc_ops_done event to record the point in time when the above  operations
 581    are finished and synchronize with this event in the non-local stream.
 582  */
 583 void gpu_launch_kernel(NbnxmGpu* nb, const gmx::StepWorkload& stepWork, const Nbnxm::InteractionLocality iloc)
 584 {
 585     cl_atomdata_t*   adat   = nb->atdat;
 586     cl_nbparam_t*    nbp    = nb->nbparam;
 587     cl_plist_t*      plist  = nb->plist[iloc];
 588     cl_timers_t*     t      = nb->timers;
 589     cl_command_queue stream = nb->stream[iloc];
 590
 591     bool bDoTime = (nb->bDoTime) != 0;
 592
 593     cl_nbparam_params_t nbparams_params;
 594
 595     /* Don't launch the non-local kernel if there is no work to do.
 596        Doing the same for the local kernel is more complicated, since the
 597        local part of the force array also depends on the non-local kernel.
 598        So to avoid complicating the code and to reduce the risk of bugs,
 599        we always call the local kernel and later (not in
 600        this function) the stream wait, local f copyback and the f buffer
 601        clearing. All these operations, except for the local interaction kernel,
 602        are needed for the non-local interactions. The skip of the local kernel
 603        call is taken care of later in this function. */
 604     if (canSkipNonbondedWork(*nb, iloc))
 605     {
 606         plist->haveFreshList = false;
 607
 608         return;
 609     }
 610
 611     if (nbp->useDynamicPruning && plist->haveFreshList)
 612     {
 613         /* Prunes for rlistOuter and rlistInner, sets plist->haveFreshList=false
 614            (that's the way the timing accounting can distinguish between
 615            separate prune kernel and combined force+prune).
 616          */
 617         Nbnxm::gpu_launch_kernel_pruneonly(nb, iloc, 1);
 618     }
 619
 620     if (plist->nsci == 0)
 621     {
 622         /* Don't launch an empty local kernel (is not allowed with OpenCL).
 623          */
 624         return;
 625     }
 626
 627     /* beginning of timed nonbonded calculation section */
 628     if (bDoTime)
 629     {
 630         t->interaction[iloc].nb_k.openTimingRegion(stream);
 631     }
 632
 633     /* kernel launch config */
 634
 635     KernelLaunchConfig config;
 636     config.sharedMemorySize = calc_shmem_required_nonbonded(nbp->vdwtype, nb->bPrefetchLjParam);
 637     config.stream           = stream;
 638     config.blockSize[0]     = c_clSize;
 639     config.blockSize[1]     = c_clSize;
 640     config.gridSize[0]      = plist->nsci;
 641
 642     validate_global_work_size(config, 3, nb->dev_info);
 643
 644     if (debug)
 645     {
 646         fprintf(debug,
 647                 "Non-bonded GPU launch configuration:\n\tLocal work size: %zux%zux%zu\n\t"
 648                 "Global work size : %zux%zu\n\t#Super-clusters/clusters: %d/%d (%d)\n",
 649                 config.blockSize[0], config.blockSize[1], config.blockSize[2],
 650                 config.blockSize[0] * config.gridSize[0], config.blockSize[1] * config.gridSize[1],
 651                 plist->nsci * c_nbnxnGpuNumClusterPerSupercluster,
 652                 c_nbnxnGpuNumClusterPerSupercluster, plist->na_c);
 653     }
 654
 655     fillin_ocl_structures(nbp, &nbparams_params);
 656
 657     auto*          timingEvent  = bDoTime ? t->interaction[iloc].nb_k.fetchNextEvent() : nullptr;
 658     constexpr char kernelName[] = "k_calc_nb";
 659     const auto     kernel =
 660             select_nbnxn_kernel(nb, nbp->eeltype, nbp->vdwtype, stepWork.computeEnergy,
 661                                 (plist->haveFreshList && !nb->timers->interaction[iloc].didPrune));
 662
 663
 664     // The OpenCL kernel takes int as second to last argument because bool is
 665     // not supported as a kernel argument type (sizeof(bool) is implementation defined).
 666     const int computeFshift = static_cast<int>(stepWork.computeVirial);
 667     if (useLjCombRule(nb->nbparam->vdwtype))
 668     {
 669         const auto kernelArgs = prepareGpuKernelArguments(
 670                 kernel, config, &nbparams_params, &adat->xq, &adat->f, &adat->e_lj, &adat->e_el,
 671                 &adat->fshift, &adat->lj_comb, &adat->shift_vec, &nbp->nbfp_climg2d, &nbp->nbfp_comb_climg2d,
 672                 &nbp->coulomb_tab_climg2d, &plist->sci, &plist->cj4, &plist->excl, &computeFshift);
 673
 674         launchGpuKernel(kernel, config, timingEvent, kernelName, kernelArgs);
 675     }
 676     else
 677     {
 678         const auto kernelArgs = prepareGpuKernelArguments(
 679                 kernel, config, &adat->ntypes, &nbparams_params, &adat->xq, &adat->f, &adat->e_lj,
 680                 &adat->e_el, &adat->fshift, &adat->atom_types, &adat->shift_vec, &nbp->nbfp_climg2d,
 681                 &nbp->nbfp_comb_climg2d, &nbp->coulomb_tab_climg2d, &plist->sci, &plist->cj4,
 682                 &plist->excl, &computeFshift);
 683         launchGpuKernel(kernel, config, timingEvent, kernelName, kernelArgs);
 684     }
 685
 686     if (bDoTime)
 687     {
 688         t->interaction[iloc].nb_k.closeTimingRegion(stream);
 689     }
 690 }
 691
 692
 693 /*! \brief Calculates the amount of shared memory required by the prune kernel.
 694  *
 695  *  Note that for the sake of simplicity we use the CUDA terminology "shared memory"
 696  *  for OpenCL local memory.
 697  *
 698  * \param[in] num_threads_z cj4 concurrency equal to the number of threads/work items in the 3-rd
 699  * dimension. \returns   the amount of local memory in bytes required by the pruning kernel
 700  */
 701 static inline int calc_shmem_required_prune(const int num_threads_z)
 702 {
 703     int shmem;
 704
 705     /* i-atom x in shared memory (for convenience we load all 4 components including q) */
 706     shmem = c_nbnxnGpuNumClusterPerSupercluster * c_clSize * sizeof(float) * 4;
 707     /* cj in shared memory, for each warp separately
 708      * Note: only need to load once per wavefront, but to keep the code simple,
 709      * for now we load twice on AMD.
 710      */
 711     shmem += num_threads_z * c_nbnxnGpuClusterpairSplit * c_nbnxnGpuJgroupSize * sizeof(int);
 712     /* Warp vote, requires one uint per warp/32 threads per block. */
 713     shmem += sizeof(cl_uint) * 2 * num_threads_z;
 714
 715     return shmem;
 716 }
 717
 718 /*! \brief
 719  * Launch the pairlist prune only kernel for the given locality.
 720  * \p numParts tells in how many parts, i.e. calls the list will be pruned.
 721  */
 722 void gpu_launch_kernel_pruneonly(NbnxmGpu* nb, const InteractionLocality iloc, const int numParts)
 723 {
 724     cl_atomdata_t*   adat    = nb->atdat;
 725     cl_nbparam_t*    nbp     = nb->nbparam;
 726     cl_plist_t*      plist   = nb->plist[iloc];
 727     cl_timers_t*     t       = nb->timers;
 728     cl_command_queue stream  = nb->stream[iloc];
 729     bool             bDoTime = nb->bDoTime == CL_TRUE;
 730
 731     if (plist->haveFreshList)
 732     {
 733         GMX_ASSERT(numParts == 1, "With first pruning we expect 1 part");
 734
 735         /* Set rollingPruningNumParts to signal that it is not set */
 736         plist->rollingPruningNumParts = 0;
 737         plist->rollingPruningPart     = 0;
 738     }
 739     else
 740     {
 741         if (plist->rollingPruningNumParts == 0)
 742         {
 743             plist->rollingPruningNumParts = numParts;
 744         }
 745         else
 746         {
 747             GMX_ASSERT(numParts == plist->rollingPruningNumParts,
 748                        "It is not allowed to change numParts in between list generation steps");
 749         }
 750     }
 751
 752     /* Use a local variable for part and update in plist, so we can return here
 753      * without duplicating the part increment code.
 754      */
 755     int part = plist->rollingPruningPart;
 756
 757     plist->rollingPruningPart++;
 758     if (plist->rollingPruningPart >= plist->rollingPruningNumParts)
 759     {
 760         plist->rollingPruningPart = 0;
 761     }
 762
 763     /* Compute the number of list entries to prune in this pass */
 764     int numSciInPart = (plist->nsci - part) / numParts;
 765
 766     /* Don't launch the kernel if there is no work to do. */
 767     if (numSciInPart <= 0)
 768     {
 769         plist->haveFreshList = false;
 770
 771         return;
 772     }
 773
 774     GpuRegionTimer* timer = nullptr;
 775     if (bDoTime)
 776     {
 777         timer = &(plist->haveFreshList ? t->interaction[iloc].prune_k : t->interaction[iloc].rollingPrune_k);
 778     }
 779
 780     /* beginning of timed prune calculation section */
 781     if (bDoTime)
 782     {
 783         timer->openTimingRegion(stream);
 784     }
 785
 786     /* Kernel launch config:
 787      * - The thread block dimensions match the size of i-clusters, j-clusters,
 788      *   and j-cluster concurrency, in x, y, and z, respectively.
 789      * - The 1D block-grid contains as many blocks as super-clusters.
 790      */
 791     int num_threads_z = getOclPruneKernelJ4Concurrency(nb->dev_info->vendor_e);
 792
 793     /* kernel launch config */
 794     KernelLaunchConfig config;
 795     config.sharedMemorySize = calc_shmem_required_prune(num_threads_z);
 796     config.stream           = stream;
 797     config.blockSize[0]     = c_clSize;
 798     config.blockSize[1]     = c_clSize;
 799     config.blockSize[2]     = num_threads_z;
 800     config.gridSize[0]      = numSciInPart;
 801
 802     validate_global_work_size(config, 3, nb->dev_info);
 803
 804     if (debug)
 805     {
 806         fprintf(debug,
 807                 "Pruning GPU kernel launch configuration:\n\tLocal work size: %zux%zux%zu\n\t"
 808                 "\tGlobal work size: %zux%zu\n\t#Super-clusters/clusters: %d/%d (%d)\n"
 809                 "\tShMem: %zu\n",
 810                 config.blockSize[0], config.blockSize[1], config.blockSize[2],
 811                 config.blockSize[0] * config.gridSize[0], config.blockSize[1] * config.gridSize[1],
 812                 plist->nsci * c_nbnxnGpuNumClusterPerSupercluster,
 813                 c_nbnxnGpuNumClusterPerSupercluster, plist->na_c, config.sharedMemorySize);
 814     }
 815
 816     cl_nbparam_params_t nbparams_params;
 817     fillin_ocl_structures(nbp, &nbparams_params);
 818
 819     auto*          timingEvent  = bDoTime ? timer->fetchNextEvent() : nullptr;
 820     constexpr char kernelName[] = "k_pruneonly";
 821     const auto     pruneKernel  = selectPruneKernel(nb->kernel_pruneonly, plist->haveFreshList);
 822     const auto     kernelArgs   = prepareGpuKernelArguments(pruneKernel, config, &nbparams_params,
 823                                                       &adat->xq, &adat->shift_vec, &plist->sci,
 824                                                       &plist->cj4, &plist->imask, &numParts, &part);
 825     launchGpuKernel(pruneKernel, config, timingEvent, kernelName, kernelArgs);
 826
 827     if (plist->haveFreshList)
 828     {
 829         plist->haveFreshList = false;
 830         /* Mark that pruning has been done */
 831         nb->timers->interaction[iloc].didPrune = true;
 832     }
 833     else
 834     {
 835         /* Mark that rolling pruning has been done */
 836         nb->timers->interaction[iloc].didRollingPrune = true;
 837     }
 838
 839     if (bDoTime)
 840     {
 841         timer->closeTimingRegion(stream);
 842     }
 843 }
 844
 845 /*! \brief
 846  * Launch asynchronously the download of nonbonded forces from the GPU
 847  * (and energies/shift forces if required).
 848  */
 849 void gpu_launch_cpyback(NbnxmGpu*                nb,
 850                         struct nbnxn_atomdata_t* nbatom,
 851                         const gmx::StepWorkload& stepWork,
 852                         const AtomLocality       aloc)
 853 {
 854     GMX_ASSERT(nb, "Need a valid nbnxn_gpu object");
 855
 856     cl_int gmx_unused cl_error;
 857     int               adat_begin, adat_len; /* local/nonlocal offset and length used for xq and f */
 858
 859     /* determine interaction locality from atom locality */
 860     const InteractionLocality iloc = gpuAtomToInteractionLocality(aloc);
 861
 862     cl_atomdata_t*   adat    = nb->atdat;
 863     cl_timers_t*     t       = nb->timers;
 864     bool             bDoTime = nb->bDoTime == CL_TRUE;
 865     cl_command_queue stream  = nb->stream[iloc];
 866
 867     /* don't launch non-local copy-back if there was no non-local work to do */
 868     if ((iloc == InteractionLocality::NonLocal) && !haveGpuShortRangeWork(*nb, iloc))
 869     {
 870         /* TODO An alternative way to signal that non-local work is
 871            complete is to use a clEnqueueMarker+clEnqueueBarrier
 872            pair. However, the use of bNonLocalStreamActive has the
 873            advantage of being local to the host, so probably minimizes
 874            overhead. Curiously, for NVIDIA OpenCL with an empty-domain
 875            test case, overall simulation performance was higher with
 876            the API calls, but this has not been tested on AMD OpenCL,
 877            so could be worth considering in future. */
 878         nb->bNonLocalStreamActive = CL_FALSE;
 879         return;
 880     }
 881
 882     getGpuAtomRange(adat, aloc, &adat_begin, &adat_len);
 883
 884     /* beginning of timed D2H section */
 885     if (bDoTime)
 886     {
 887         t->xf[aloc].nb_d2h.openTimingRegion(stream);
 888     }
 889
 890     /* With DD the local D2H transfer can only start after the non-local
 891        has been launched. */
 892     if (iloc == InteractionLocality::Local && nb->bNonLocalStreamActive)
 893     {
 894         sync_ocl_event(stream, &(nb->nonlocal_done));
 895     }
 896
 897     /* DtoH f */
 898     ocl_copy_D2H_async(nbatom->out[0].f.data() + adat_begin * DIM, adat->f,
 899                        adat_begin * DIM * sizeof(nbatom->out[0].f[0]),
 900                        adat_len * DIM * sizeof(nbatom->out[0].f[0]), stream,
 901                        bDoTime ? t->xf[aloc].nb_d2h.fetchNextEvent() : nullptr);
 902
 903     /* kick off work */
 904     cl_error = clFlush(stream);
 905     GMX_ASSERT(cl_error == CL_SUCCESS, ("clFlush failed: " + ocl_get_error_string(cl_error)).c_str());
 906
 907     /* After the non-local D2H is launched the nonlocal_done event can be
 908        recorded which signals that the local D2H can proceed. This event is not
 909        placed after the non-local kernel because we first need the non-local
 910        data back first. */
 911     if (iloc == InteractionLocality::NonLocal)
 912     {
 913         cl_error = clEnqueueMarkerWithWaitList(stream, 0, nullptr, &(nb->nonlocal_done));
 914         GMX_ASSERT(cl_error == CL_SUCCESS,
 915                    ("clEnqueueMarkerWithWaitList failed: " + ocl_get_error_string(cl_error)).c_str());
 916         nb->bNonLocalStreamActive = CL_TRUE;
 917     }
 918
 919     /* only transfer energies in the local stream */
 920     if (iloc == InteractionLocality::Local)
 921     {
 922         /* DtoH fshift when virial is needed */
 923         if (stepWork.computeVirial)
 924         {
 925             ocl_copy_D2H_async(nb->nbst.fshift, adat->fshift, 0, SHIFTS * sizeof(nb->nbst.fshift[0]),
 926                                stream, bDoTime ? t->xf[aloc].nb_d2h.fetchNextEvent() : nullptr);
 927         }
 928
 929         /* DtoH energies */
 930         if (stepWork.computeEnergy)
 931         {
 932             ocl_copy_D2H_async(nb->nbst.e_lj, adat->e_lj, 0, sizeof(float), stream,
 933                                bDoTime ? t->xf[aloc].nb_d2h.fetchNextEvent() : nullptr);
 934
 935             ocl_copy_D2H_async(nb->nbst.e_el, adat->e_el, 0, sizeof(float), stream,
 936                                bDoTime ? t->xf[aloc].nb_d2h.fetchNextEvent() : nullptr);
 937         }
 938     }
 939
 940     if (bDoTime)
 941     {
 942         t->xf[aloc].nb_d2h.closeTimingRegion(stream);
 943     }
 944 }
 945
 946
 947 /*! \brief Selects the Ewald kernel type, analytical or tabulated, single or twin cut-off. */
 948 int nbnxn_gpu_pick_ewald_kernel_type(const interaction_const_t& ic)
 949 {
 950     bool bTwinCut = (ic.rcoulomb != ic.rvdw);
 951     bool bUseAnalyticalEwald, bForceAnalyticalEwald, bForceTabulatedEwald;
 952     int  kernel_type;
 953
 954     /* Benchmarking/development environment variables to force the use of
 955        analytical or tabulated Ewald kernel. */
 956     bForceAnalyticalEwald = (getenv("GMX_OCL_NB_ANA_EWALD") != nullptr);
 957     bForceTabulatedEwald  = (getenv("GMX_OCL_NB_TAB_EWALD") != nullptr);
 958
 959     if (bForceAnalyticalEwald && bForceTabulatedEwald)
 960     {
 961         gmx_incons(
 962                 "Both analytical and tabulated Ewald OpenCL non-bonded kernels "
 963                 "requested through environment variables.");
 964     }
 965
 966     /* OpenCL: By default, use analytical Ewald
 967      * TODO: tabulated does not work, it needs fixing, see init_nbparam() in nbnxn_ocl_data_mgmt.cpp
 968      *
 969      */
 970     /* By default use analytical Ewald. */
 971     bUseAnalyticalEwald = true;
 972     if (bForceAnalyticalEwald)
 973     {
 974         if (debug)
 975         {
 976             fprintf(debug, "Using analytical Ewald OpenCL kernels\n");
 977         }
 978     }
 979     else if (bForceTabulatedEwald)
 980     {
 981         bUseAnalyticalEwald = false;
 982
 983         if (debug)
 984         {
 985             fprintf(debug, "Using tabulated Ewald OpenCL kernels\n");
 986         }
 987     }
 988
 989     /* Use twin cut-off kernels if requested by bTwinCut or the env. var.
 990        forces it (use it for debugging/benchmarking only). */
 991     if (!bTwinCut && (getenv("GMX_OCL_NB_EWALD_TWINCUT") == nullptr))
 992     {
 993         kernel_type = bUseAnalyticalEwald ? eelOclEWALD_ANA : eelOclEWALD_TAB;
 994     }
 995     else
 996     {
 997         kernel_type = bUseAnalyticalEwald ? eelOclEWALD_ANA_TWIN : eelOclEWALD_TAB_TWIN;
 998     }
 999
1000     return kernel_type;
1001 }
1002
1003 } // namespace Nbnxm